Uh oh!
There was an error while loading. Please reload this page.
Add more consistency tests - #4983
Conversation
hauntsaninja
left a comment
There was a problem hiding this comment.
Might make sense to add a check that all stdlib modules have an entry in VERSIONS
| for _, dirs, files in os.walk(directory): | ||
| for file in files: | ||
| name, ext = os.path.splitext(file) | ||
| assert name.isidentifier(), "Files must be valid modules" |
There was a problem hiding this comment.
Should add the name to the assertion failure to make the failure more debuggable. Same for a number of other checks below.
(Also, is there a reason not to use f-strings here?)
JukkaL
left a comment
There was a problem hiding this comment.
Thanks for adding the tests! These will help prevent all sorts weird failure modes that would otherwise be possible, such as breaking the build pipeline.
Looks good, mostly left comments about missing details in error messages.
| assert name.isidentifier(), "Files must be valid modules" | ||
| assert ext == ".pyi", "Only stub flies allowed. Got: {} in {}".format(file, directory) | ||
| for subdir in dirs: | ||
| assert subdir.isidentifier(), "Directories must be valid packages" |
There was a problem hiding this comment.
Also include the name of the subdir in the message.
| def check_stubs(): | ||
| for distribution in os.listdir("stubs"): | ||
| assert not os.path.isfile(distribution), "Only directories allowed in stubs" |
There was a problem hiding this comment.
Show distribution in the error message.
| if ext != ".pyi": | ||
| assert entry in {"METADATA.toml", "README", "README.md", "README.rst"}, entry | ||
| else: | ||
| assert name.isidentifier(), "Bad file name in stubs" |
There was a problem hiding this comment.
Include name in the error message.
| if os.path.isfile(os.path.join("stubs", distribution, "@python2", entry)): | ||
| name, ext = os.path.splitext(entry) | ||
| assert name.isidentifier(), "Bad file name in stubs" | ||
| assert ext == ".pyi", "Unexpected file in @python2 stubs" |
There was a problem hiding this comment.
Include file name in the above two error messages.
| main() | ||
| check_stdlib() | ||
| check_stubs() | ||
| check_same_files() |
There was a problem hiding this comment.
Should we also validate METADATA.toml files here?
There was a problem hiding this comment.
I think yes. I will add a test for it too.
JukkaL
left a comment
There was a problem hiding this comment.
Thanks for the updates! Can you create a follow-up issue about better dependency tests?
| data = toml.loads(f.read()) | ||
| assert "version" in data, f"Missing version for {distribution}" | ||
| version = data["version"] | ||
| msg = f"Unsupported Python version{version}" |
There was a problem hiding this comment.
Nit: add space after 'version'?
Follow up fo #4971