Add "Naming convention" to test_cases/README.md
#8521
Merged
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
JelleZijlstra
requested changes
Aug 10, 2022
test_cases/README.md
Outdated
| Use the same top-level name for the module / package you would like to test. | ||
| Use `test_${thing}.py` naming pattern for individual test files. | ||
| For example: | ||
| - Tests for `gather` defined in `stdlib/asyncio/tasks.pyi` will go into `stdlib/asyncio/test_gather.py` |
There was a problem hiding this comment.
Suggested change
| - Tests for `gather` defined in `stdlib/asyncio/tasks.pyi` will go into `stdlib/asyncio/test_gather.py` | |
| - Tests for `gather` defined in `stdlib/asyncio/tasks.pyi` will go into `stdlib/asyncio/tasks/test_gather.py` |
There was a problem hiding this comment.
Should we move it then? https://github.com/python/typeshed/blob/master/test_cases/stdlib/asyncio/test_gather.py
test_cases/README.md
Outdated
| Use `test_${thing}.py` naming pattern for individual test files. | ||
| For example: | ||
| - Tests for `gather` defined in `stdlib/asyncio/tasks.pyi` will go into `stdlib/asyncio/test_gather.py` | ||
| - Tests for `ExitStack` defined in `stdlib/contextlib.pyi` will go into `stdlib/test_contextlib.py` |
There was a problem hiding this comment.
These examples don't show why ExitStack goes into test_contextlib directly, but pow doesn't go into test_builtins. We should add something like "By default, tests go into a test file with the same name as the stub file, prefixed with test_. For example: test_contextlib. If that file becomes too big, we instead create a directory with files named after individual objects being tested. For example: builtins/test_dict."
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
JelleZijlstra
approved these changes
Aug 13, 2022
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.
Refs #8520