Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
203 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # flake8: noqa | ||
| """ | ||
| Backport of PEP 562. | ||
| https://pypi.org/search/?q=pep562 | ||
| Licensed under MIT | ||
| Copyright (c) 2018 Isaac Muse <isaacmuse@gmail.com> | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
| documentation files (the "Software"), to deal in the Software without restriction, including without limitation | ||
| the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, | ||
| and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions | ||
| of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED | ||
| TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | ||
| THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF | ||
| CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | ||
| IN THE SOFTWARE. | ||
| """ | ||
| import sys | ||
| from typing import Any, Callable, List, Optional | ||
|
|
||
|
|
||
| class Pep562: | ||
| """ | ||
| Backport of PEP 562 <https://pypi.org/search/?q=pep562>. | ||
| Wraps the module in a class that exposes the mechanics to override `__dir__` and `__getattr__`. | ||
| The given module will be searched for overrides of `__dir__` and `__getattr__` and use them when needed. | ||
| """ | ||
|
|
||
| def __init__(self, name: str) -> None: # pragma: no cover | ||
| """Acquire `__getattr__` and `__dir__`, but only replace module for versions less than Python 3.7.""" | ||
|
|
||
| self._module = sys.modules[name] | ||
| self._get_attr = getattr(self._module, "__getattr__", None) | ||
| self._get_dir: Optional[Callable[..., List[str]]] = getattr( | ||
| self._module, "__dir__", None | ||
| ) | ||
| sys.modules[name] = self # type: ignore[assignment] | ||
|
|
||
| def __dir__(self) -> List[str]: # pragma: no cover | ||
| """Return the overridden `dir` if one was provided, else apply `dir` to the module.""" | ||
|
|
||
| return self._get_dir() if self._get_dir else dir(self._module) | ||
|
|
||
| def __getattr__(self, name: str) -> Any: # pragma: no cover | ||
| """ | ||
| Attempt to retrieve the attribute from the module, and if missing, use the overridden function if present. | ||
| """ | ||
|
|
||
| try: | ||
| return getattr(self._module, name) | ||
| except AttributeError: | ||
| if self._get_attr: | ||
| return self._get_attr(name) | ||
| raise | ||
|
|
||
|
|
||
| def pep562(module_name: str) -> None: # pragma: no cover | ||
| """Helper function to apply PEP 562.""" | ||
|
|
||
| if sys.version_info < (3, 7): | ||
| Pep562(module_name) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import importlib | ||
|
|
||
| import pytest | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "constant,msg", | ||
| ( | ||
| ( | ||
| "WS_1004_NO_STATUS_RCVD", | ||
| "'WS_1004_NO_STATUS_RCVD' is deprecated. " | ||
| "Use 'WS_1005_NO_STATUS_RCVD' instead.", | ||
| ), | ||
| ( | ||
| "WS_1005_ABNORMAL_CLOSURE", | ||
| "'WS_1005_ABNORMAL_CLOSURE' is deprecated. " | ||
| "Use 'WS_1006_ABNORMAL_CLOSURE' instead.", | ||
| ), | ||
| ), | ||
| ) | ||
| def test_deprecated_types(constant: str, msg: str) -> None: | ||
| with pytest.warns(DeprecationWarning) as record: | ||
| getattr(importlib.import_module("starlette.status"), constant) | ||
| assert len(record) == 1 | ||
| assert msg in str(record.list[0]) |