Align setUp and tearDown type signatures with unittest and rdflib.plugin
#111
Conversation
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
ajnelson-nist
changed the title
setUp and tearDown type signatures with unitest and rdflib.pluginsetUp and tearDown type signatures with unittest and rdflib.plugin
The references below indicate the type requirements' sources.
When reviewing subclasses of `GraphTestCase`, `setUp` and `tearDown` did
no further work than the parent class `GraphTestCase` once the
signatures were aligned with `typeshed.stdlib`, so the methods were
removed.
This patch was driven by the following command after activating type
review on `setUp` and `tearDown` (adding `-> None`):
```bash
mypy test/test_sqlalchemy_sqlite.py
```
This patch was then tested with the following command after identifying
sibling ("cousin?") classes of the SQLite test. This command raised no
errors after deactivating type review (adding `# type: ignore`) on a
package that does not currently provide type signatures:
```bash
mypy \
test/test_sqlalchemy_mysql.py \
test/test_sqlalchemy_postgresql.py \
test/test_sqlalchemy_postgresql_pg8000.py \
test/test_sqlalchemy_sqlite.py
```
Disclaimer:
Participation by NIST in the creation of the documentation of mentioned
software is not intended to imply a recommendation or endorsement by the
National Institute of Standards and Technology, nor is it intended to
imply that any specific software is necessarily the best available for
the purpose.
References:
* https://github.com/RDFLib/rdflib/blob/7.1.1/rdflib/plugin.py#L128
* https://github.com/python/typeshed/blob/b40eb642e00c538e29fb037992eb4b21d9ff108c/stdlib/unittest/case.pyi#L119-L120
Signed-off-by: Alex Nelson <[email protected]>
|
Force-pushing to fix a typo in the commit message. |
ajnelson-nist
force-pushed
the
align_setup_teardown_signatures
branch
from
d43fbb9 to
409bae8
Compare
nicholascar
approved these changes
Dec 17, 2024
edmondchuc
approved these changes
Dec 17, 2024
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 references below indicate the type requirements' sources.
When reviewing subclasses of
GraphTestCase,setUpandtearDowndid no further work than the parent classGraphTestCaseonce the signatures were aligned withtypeshed.stdlib, so the methods were removed.The first patch was driven by the following command after activating type review on
setUpandtearDown(adding-> None):The first patch was then tested with the following command after identifying sibling ("cousin?") classes of the SQLite test. This command raised no errors after deactivating type review (adding
# type: ignore) on a package that does not currently provide type signatures:Note: The first patch was not tested by re-running the test suite. However, I do think it will help with future review.
Disclaimer:
Participation by NIST in the creation of the documentation of mentioned software is not intended to imply a recommendation or endorsement by the National Institute of Standards and Technology, nor is it intended to imply that any specific software is necessarily the best available for the purpose.
References