Fix pip install -e .[dev] on Python 3.9
#182
Open
Conversation
This file contains hidden or 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
The Sphinx extension `sphinx-autodoc-typehints` requires Python 3.10 or newer. This breaks `pip install -e .[dev]` when on Python 3.9. It makes sense to keep supporting local Python 3.9 installs, because that’s the minimum Python version that dataclass_wizard supports. Contributors may prefer installing that minimum Python version on their local dev environment, because it helps them avoid language elements and batteries that Python 3.9 doesn’t support. Add a condition in both `docs/requirements.txt` and `docs/conf.py` to unblock `pip install -e .[dev]`. Note that CI never caught this issue, because `setup.py` conditionally ignores extra dependencies when on CI.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Sphinx extension
sphinx-autodoc-typehintsrequires Python 3.10 or newer. This breakspip install -e .[dev]when on Python 3.9.It makes sense to keep supporting local Python 3.9 installs, because that’s the minimum Python version that dataclass_wizard supports.
Contributors may prefer installing that minimum Python version on their local dev environment, because it helps them avoid language elements and batteries that Python 3.9 doesn’t support.
This PR adds a condition to both
docs/requirements.txtanddocs/conf.pyto unblockpip install -e .[dev].Note that CI never caught this issue, because
setup.pyconditionally ignores extra dependencies when on CI.