zulip/zerver/lib/user_agent.py

import re

# Warning: If you change this parsing, please test using
#   zerver/tests/test_decorators.py
# And extend zerver/tests/fixtures/user_agents_unique with any new test cases
pattern = re.compile(
    r"""^ (?P<name> [^/ ]* [^0-9/(]* )
    (/ (?P<version> [^/ ]* ))?
    ([ /] .*)?
    $""",
    re.VERBOSE,
)


def parse_user_agent(user_agent: str) -> dict[str, str]:
    match = pattern.match(user_agent)
    assert match is not None
    return match.groupdict()
Add script to parse user agents with historical data set. (imported from commit e529c0b914ed3d3d06e9581a6239676f68c97b3f) 2013-12-06 23:59:06 +01:00			`import re`

			`# Warning: If you change this parsing, please test using`
tests: Replace test_user_agent_parsing with a normal test. Previously, this was its own separate test script; now it's a normal part of the test suite. Tweaked by tabbott to use a proper test method. Fixes #6327. 2017-09-16 08:24:17 +02:00			`# zerver/tests/test_decorators.py`
tests: Move zerver/fixtures to zerver/tests/fixtures for clarity. Fixes #9153. 2018-04-19 20:17:24 +02:00			`# And extend zerver/tests/fixtures/user_agents_unique with any new test cases`
user_agent: Compile the regular expression. We use this single regular expression for processing essentially every request, so it's definitely worth hinting to Python that we're going to do so by compiling it. Saves about 40us per request. 2020-02-14 19:20:54 +01:00			`pattern = re.compile(`
python: Mark regexes as raw strings. Signed-off-by: Anders Kaseorg <anders@zulip.com> 2024-04-26 20:30:22 +02:00			`r"""^ (?P<name> [^/ ]* [^0-9/(]* )`
user_agent: Compile the regular expression. We use this single regular expression for processing essentially every request, so it's definitely worth hinting to Python that we're going to do so by compiling it. Saves about 40us per request. 2020-02-14 19:20:54 +01:00			`(/ (?P<version> [^/ ]* ))?`
			`([ /] .*)?`
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com> 2021-02-12 08:19:30 +01:00			`$""",`
ruff: Fix FURB167 Use of regular expression alias. Signed-off-by: Anders Kaseorg <anders@zulip.com> 2024-06-30 20:29:07 +02:00			`re.VERBOSE,`
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com> 2021-02-12 08:19:30 +01:00			`)`

user_agent: Compile the regular expression. We use this single regular expression for processing essentially every request, so it's definitely worth hinting to Python that we're going to do so by compiling it. Saves about 40us per request. 2020-02-14 19:20:54 +01:00
ruff: Fix UP006 Use `list` instead of `List` for type annotation. Signed-off-by: Anders Kaseorg <anders@zulip.com> 2024-07-12 02:30:17 +02:00			`def parse_user_agent(user_agent: str) -> dict[str, str]:`
user_agent: Compile the regular expression. We use this single regular expression for processing essentially every request, so it's definitely worth hinting to Python that we're going to do so by compiling it. Saves about 40us per request. 2020-02-14 19:20:54 +01:00			`match = pattern.match(user_agent)`
parse_user_agent: Assert user agent is not None. This commit asserts that parse_user_agent never returns None. The RegEx will match any string, so that `match` is never None. This brings test coverage of lib/user_agent.py to 100%. Changes were also made in test/test_decorators.py and views/compatibility.py to reflect that parse_user_agent cannot return None. Improves: #7089. Fixes: #8779. 2018-03-22 20:02:15 +01:00			`assert match is not None`
Add script to parse user agents with historical data set. (imported from commit e529c0b914ed3d3d06e9581a6239676f68c97b3f) 2013-12-06 23:59:06 +01:00			`return match.groupdict()`