summary refs log tree commit diff
path: root/synapse/http/servlet.py
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2018-11-14 11:54:29 +0000
committerRichard van der Hoff <richard@matrix.org>2018-11-14 11:54:29 +0000
commitb699178aa153eb6285fa4c582f7d287ee23c8497 (patch)
treeac890bdd98c9f84b9e18ce26fcea4fccad7c562c /synapse/http/servlet.py
parentMerge remote-tracking branch 'origin/erikj/fix_device_comparison' into matrix... (diff)
parentMerge pull request #4184 from matrix-org/rav/fix_public_consent (diff)
downloadsynapse-b699178aa153eb6285fa4c582f7d287ee23c8497.tar.xz
Merge branch 'develop' into matrix-org-hotfixes
Diffstat (limited to 'synapse/http/servlet.py')
-rw-r--r--synapse/http/servlet.py9
1 files changed, 4 insertions, 5 deletions
diff --git a/synapse/http/servlet.py b/synapse/http/servlet.py

index a1e4b88e6d..528125e737 100644 --- a/synapse/http/servlet.py +++ b/synapse/http/servlet.py
@@ -121,16 +121,15 @@ def parse_string(request, name, default=None, required=False, Args: request: the twisted HTTP request. - name (bytes/unicode): the name of the query parameter. - default (bytes/unicode|None): value to use if the parameter is absent, + name (bytes|unicode): the name of the query parameter. + default (bytes|unicode|None): value to use if the parameter is absent, defaults to None. Must be bytes if encoding is None. required (bool): whether to raise a 400 SynapseError if the parameter is absent, defaults to False. - allowed_values (list[bytes/unicode]): List of allowed values for the + allowed_values (list[bytes|unicode]): List of allowed values for the string, or None if any value is allowed, defaults to None. Must be the same type as name, if given. - encoding: The encoding to decode the name to, and decode the string - content with. + encoding (str|None): The encoding to decode the string content with. Returns: bytes/unicode|None: A string value or the default. Unicode if encoding