mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-12-11 10:14:22 -05:00
Fixup docstrings for matrixfederationclient
This commit is contained in:
parent
d91b99abe0
commit
34ea14139d
@ -229,19 +229,18 @@ class MatrixFederationHttpClient(object):
|
|||||||
backoff_on_404 (bool): Back off if we get a 404
|
backoff_on_404 (bool): Back off if we get a 404
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Deferred: resolves with the http response object on success.
|
Deferred[twisted.web.client.Response]: resolves with the HTTP
|
||||||
|
response object on success.
|
||||||
|
|
||||||
Fails with ``HttpResponseException``: if we get an HTTP response
|
Raises:
|
||||||
code >= 300 (except 429).
|
HttpResponseException: If we get an HTTP response code >= 300
|
||||||
|
(except 429).
|
||||||
Fails with ``NotRetryingDestination`` if we are not yet ready
|
NotRetryingDestination: If we are not yet ready to retry this
|
||||||
to retry this server.
|
server.
|
||||||
|
FederationDeniedError: If this destination is not on our
|
||||||
Fails with ``FederationDeniedError`` if this destination
|
federation whitelist
|
||||||
is not on our federation whitelist
|
RequestSendFailed: If there were problems connecting to the
|
||||||
|
remote, due to e.g. DNS failures, connection timeouts etc.
|
||||||
Fails with ``RequestSendFailed`` if there were problems connecting to
|
|
||||||
the remote, due to e.g. DNS failures, connection timeouts etc.
|
|
||||||
"""
|
"""
|
||||||
if timeout:
|
if timeout:
|
||||||
_sec_timeout = timeout / 1000
|
_sec_timeout = timeout / 1000
|
||||||
@ -516,17 +515,18 @@ class MatrixFederationHttpClient(object):
|
|||||||
requests)
|
requests)
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Deferred: Succeeds when we get a 2xx HTTP response. The result
|
Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The
|
||||||
will be the decoded JSON body.
|
result will be the decoded JSON body.
|
||||||
|
|
||||||
Fails with ``HttpResponseException`` if we get an HTTP response
|
Raises:
|
||||||
code >= 300.
|
HttpResponseException: If we get an HTTP response code >= 300
|
||||||
|
(except 429).
|
||||||
Fails with ``NotRetryingDestination`` if we are not yet ready
|
NotRetryingDestination: If we are not yet ready to retry this
|
||||||
to retry this server.
|
server.
|
||||||
|
FederationDeniedError: If this destination is not on our
|
||||||
Fails with ``FederationDeniedError`` if this destination
|
federation whitelist
|
||||||
is not on our federation whitelist
|
RequestSendFailed: If there were problems connecting to the
|
||||||
|
remote, due to e.g. DNS failures, connection timeouts etc.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
request = MatrixFederationRequest(
|
request = MatrixFederationRequest(
|
||||||
@ -570,17 +570,18 @@ class MatrixFederationHttpClient(object):
|
|||||||
try the request anyway.
|
try the request anyway.
|
||||||
args (dict): query params
|
args (dict): query params
|
||||||
Returns:
|
Returns:
|
||||||
Deferred: Succeeds when we get a 2xx HTTP response. The result
|
Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The
|
||||||
will be the decoded JSON body.
|
result will be the decoded JSON body.
|
||||||
|
|
||||||
Fails with ``HttpResponseException`` if we get an HTTP response
|
Raises:
|
||||||
code >= 300.
|
HttpResponseException: If we get an HTTP response code >= 300
|
||||||
|
(except 429).
|
||||||
Fails with ``NotRetryingDestination`` if we are not yet ready
|
NotRetryingDestination: If we are not yet ready to retry this
|
||||||
to retry this server.
|
server.
|
||||||
|
FederationDeniedError: If this destination is not on our
|
||||||
Fails with ``FederationDeniedError`` if this destination
|
federation whitelist
|
||||||
is not on our federation whitelist
|
RequestSendFailed: If there were problems connecting to the
|
||||||
|
remote, due to e.g. DNS failures, connection timeouts etc.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
request = MatrixFederationRequest(
|
request = MatrixFederationRequest(
|
||||||
@ -625,17 +626,18 @@ class MatrixFederationHttpClient(object):
|
|||||||
ignore_backoff (bool): true to ignore the historical backoff data
|
ignore_backoff (bool): true to ignore the historical backoff data
|
||||||
and try the request anyway.
|
and try the request anyway.
|
||||||
Returns:
|
Returns:
|
||||||
Deferred: Succeeds when we get a 2xx HTTP response. The result
|
Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The
|
||||||
will be the decoded JSON body.
|
result will be the decoded JSON body.
|
||||||
|
|
||||||
Fails with ``HttpResponseException`` if we get an HTTP response
|
Raises:
|
||||||
code >= 300.
|
HttpResponseException: If we get an HTTP response code >= 300
|
||||||
|
(except 429).
|
||||||
Fails with ``NotRetryingDestination`` if we are not yet ready
|
NotRetryingDestination: If we are not yet ready to retry this
|
||||||
to retry this server.
|
server.
|
||||||
|
FederationDeniedError: If this destination is not on our
|
||||||
Fails with ``FederationDeniedError`` if this destination
|
federation whitelist
|
||||||
is not on our federation whitelist
|
RequestSendFailed: If there were problems connecting to the
|
||||||
|
remote, due to e.g. DNS failures, connection timeouts etc.
|
||||||
"""
|
"""
|
||||||
logger.debug("get_json args: %s", args)
|
logger.debug("get_json args: %s", args)
|
||||||
|
|
||||||
@ -676,17 +678,18 @@ class MatrixFederationHttpClient(object):
|
|||||||
ignore_backoff (bool): true to ignore the historical backoff data and
|
ignore_backoff (bool): true to ignore the historical backoff data and
|
||||||
try the request anyway.
|
try the request anyway.
|
||||||
Returns:
|
Returns:
|
||||||
Deferred: Succeeds when we get a 2xx HTTP response. The result
|
Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The
|
||||||
will be the decoded JSON body.
|
result will be the decoded JSON body.
|
||||||
|
|
||||||
Fails with ``HttpResponseException`` if we get an HTTP response
|
Raises:
|
||||||
code >= 300.
|
HttpResponseException: If we get an HTTP response code >= 300
|
||||||
|
(except 429).
|
||||||
Fails with ``NotRetryingDestination`` if we are not yet ready
|
NotRetryingDestination: If we are not yet ready to retry this
|
||||||
to retry this server.
|
server.
|
||||||
|
FederationDeniedError: If this destination is not on our
|
||||||
Fails with ``FederationDeniedError`` if this destination
|
federation whitelist
|
||||||
is not on our federation whitelist
|
RequestSendFailed: If there were problems connecting to the
|
||||||
|
remote, due to e.g. DNS failures, connection timeouts etc.
|
||||||
"""
|
"""
|
||||||
request = MatrixFederationRequest(
|
request = MatrixFederationRequest(
|
||||||
method="DELETE",
|
method="DELETE",
|
||||||
@ -719,18 +722,20 @@ class MatrixFederationHttpClient(object):
|
|||||||
args (dict): Optional dictionary used to create the query string.
|
args (dict): Optional dictionary used to create the query string.
|
||||||
ignore_backoff (bool): true to ignore the historical backoff data
|
ignore_backoff (bool): true to ignore the historical backoff data
|
||||||
and try the request anyway.
|
and try the request anyway.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Deferred: resolves with an (int,dict) tuple of the file length and
|
Deferred[tuple[int, dict]]: Resolves with an (int,dict) tuple of
|
||||||
a dict of the response headers.
|
the file length and a dict of the response headers.
|
||||||
|
|
||||||
Fails with ``HttpResponseException`` if we get an HTTP response code
|
Raises:
|
||||||
>= 300
|
HttpResponseException: If we get an HTTP response code >= 300
|
||||||
|
(except 429).
|
||||||
Fails with ``NotRetryingDestination`` if we are not yet ready
|
NotRetryingDestination: If we are not yet ready to retry this
|
||||||
to retry this server.
|
server.
|
||||||
|
FederationDeniedError: If this destination is not on our
|
||||||
Fails with ``FederationDeniedError`` if this destination
|
federation whitelist
|
||||||
is not on our federation whitelist
|
RequestSendFailed: If there were problems connecting to the
|
||||||
|
remote, due to e.g. DNS failures, connection timeouts etc.
|
||||||
"""
|
"""
|
||||||
request = MatrixFederationRequest(
|
request = MatrixFederationRequest(
|
||||||
method="GET",
|
method="GET",
|
||||||
|
Loading…
Reference in New Issue
Block a user