diff options
author | Travis Ralston <travpc@gmail.com> | 2018-11-27 14:04:22 -0700 |
---|---|---|
committer | Travis Ralston <travpc@gmail.com> | 2018-11-27 14:04:22 -0700 |
commit | bc50cffa2698a484dffda0e1f64c832132b1ff48 (patch) | |
tree | 401ed265c319a277506cb4ddfe9c12bbcb0d4716 /synapse/http/servlet.py | |
parent | More timeout (diff) | |
parent | Support m.login.sso (#4220) (diff) | |
download | synapse-bc50cffa2698a484dffda0e1f64c832132b1ff48.tar.xz |
Merge branch 'develop' into travis/intentional-timeout github/travis/intentional-timeout travis/intentional-timeout
Diffstat (limited to 'synapse/http/servlet.py')
-rw-r--r-- | synapse/http/servlet.py | 9 |
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 |