Support typing.Literal in python 3.8 #1027
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1027 +/- ##
======================================
Coverage 100% 100%
======================================
Files 19 19
Lines 3299 3293 -6
Branches 651 651
======================================
- Hits 3299 3293 -6
Continue to review full report at Codecov.
|
| except ImportError: | ||
| Literal = None # type: ignore | ||
|
|
||
| if sys.version_info < (3, 8): |
There was a problem hiding this comment.
Needed to use the sys.version_info check for mypy compatibility with both 3.8 and <=3.7
dmontagu
force-pushed
the
literal-3.8
branch
from
1c4eaa5
to
eb33de5
Compare
| if sys.version_info < (3, 8): | ||
| if TYPE_CHECKING: | ||
| from typing_extensions import Literal | ||
| else: # due to different mypy warnings raised during CI for python 3.7 and 3.8 |
There was a problem hiding this comment.
Had to add this gross if TYPE_CHECKING: block here because the Literal = None line was causing an "unnecessary ignore" warning during the 3.8 build. This approach seems fine to me here, but I'm open to alternatives.
There was a problem hiding this comment.
This is a known issue in mypy with one developer commenting that --warn-unused-ignores is not recommended for use in CI. But barring that you can trick mypy into interpreting Literal as a Union with:
if sys.version_info < (3, 8):
try:
from typing_extensions import Literal as _Literal
except ImportError:
Literal = None
else:
Literal = _Literal
else:
from typing import LiteralThere was a problem hiding this comment.
Thanks for sharing the issue, and the workaround.
I definitely would prefer to keep that check on in CI though; otherwise it's too easy to accidentally forget, and then end up with confusion about what is being ignored and/or ignore a future error that should have been caught.
There was a problem hiding this comment.
agreed, I hoped mypy would have a type: ignore flexible option, but couldn't find anything.
|
@samuelcolvin Modulo the remaining ugly |
|
awesome, thank you. |
* Support typing.Literal in python 3.8 * Improve import pattern for Literal * Update references to in docs * Try to get build to pass
* Support typing.Literal in python 3.8 * Improve import pattern for Literal * Update references to in docs * Try to get build to pass
* Refactor ._iter() method: Moved all keys-related stuff (include, exclude, etc.) to ._iter() Removed redundant iteration through default values Almost all arguments checks moved out of loops, so checks happen once Fast yield from .__dict__ on plain .iter() (x10 boost) Removed redundant set(dict.keys()) in ._calculate_keys() * Moved back from nested generator checks to checks, optimized copy a bit * Bump pytest-mock from 1.12.0 to 1.12.1 (#1018) Bumps [pytest-mock](https://github.com/pytest-dev/pytest-mock) from 1.12.0 to 1.12.1. - [Release notes](https://github.com/pytest-dev/pytest-mock/releases) - [Changelog](https://github.com/pytest-dev/pytest-mock/blob/master/CHANGELOG.rst) - [Commits](pytest-dev/pytest-mock@v1.12.0...v1.12.1) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * __str__ and __repr__ inheritance for models, fix #1022 (#1023) * add testimonials section to docs with reference to python bytes podcast episode (#1025) * add testimonials section with reference to python bytes podcast episode * added description to changes directory * Bump twine from 3.0.0 to 3.1.0 (#1029) Bumps [twine](https://github.com/pypa/twine) from 3.0.0 to 3.1.0. - [Release notes](https://github.com/pypa/twine/releases) - [Changelog](https://github.com/pypa/twine/blob/master/docs/changelog.rst) - [Commits](pypa/twine@3.0.0...3.1.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Support typing.Literal in python 3.8 (#1027) * Support typing.Literal in python 3.8 * Improve import pattern for Literal * Update references to in docs * Try to get build to pass * Add support for mapping types as custom root (#958) * Add support for mapping types as custom root * Incorporate feedback * Add changes * Incorporate feedback * Add docs and tests * Fix linting issue * Incorporate more feedback * Add more specific match * Add parse_as_type function (#934) * Add parse_as_type function * Add changes * Incorporate feedback * Add naming tests * Fix double quotes * Fix docs example * Reorder parameters; add dataclass and mapping tests * Rename parse_as_type to parse_obj, and add parse_file * Incorporate feedback * Incorporate feedback * use custom root types * Add better support for validator reuse (#941) * Add better support for validator reuse * Clean up classmethod unpacking * Add changes * Fix coverage check * Make 3.8 compatible * Update changes/940-dmontagu.md Co-Authored-By: Samuel Colvin <s@muelcolvin.com> * Make allow_reuse discoverable by adding to error message * switch _check_validator_name to _prepare_validator * Add changes file * Delete unrelated files * Add check that k in fields before using alias Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * Remove redundant call to __iter__ Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * Use typing.AbstractSet * Update pydantic/main.py Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> Co-authored-by: Samuel Colvin <samcolvin@gmail.com> Co-authored-by: Colin Sullivan <csullivan@brandwatch.com> Co-authored-by: David Montague <35119617+dmontagu@users.noreply.github.com>
Change Summary
Attempt to use
typing.Literalif available (e.g., with python 3.8).Related issue number
Closes #1026
Checklist
changes/<pull request or issue id>-<github username>.mdfile added describing change(see changes/README.md for details)