Reorg module metadata and test directory to avoid namespace clashes #33
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
clebergnu
force-pushed
the
lint_avoid_conflicts
branch
2 times, most recently
from
eef1cfc to
42b115d
Compare
Because some tools, such as pylint, will mimic the import of Python modules, they can get confused on the test directory structure, and confuse it with the file containing the module implementation. For instance, because there is currently: autils/archive/ar.py And: tests/autils/archive/ar.py Pylint may consider the later to be the former. Because we don't need the autils component in the tests, and because it's not expected that this repo will contain anything other than module implementations under the "autils" component, the simplest solution is to drop it. For consistency, this also drops it from the metadata directory. Signed-off-by: Cleber Rosa <[email protected]>
clebergnu
force-pushed
the
lint_avoid_conflicts
branch
from
42b115d to
a90c81c
Compare
clebergnu
changed the title
harvey0100
approved these changes
Dec 3, 2024
There was a problem hiding this comment.
LGTM - have adjusted website workflow towards new structure also in PR.
avocado-framework/avocado-framework.github.io#33
richtja
approved these changes
Dec 3, 2024
There was a problem hiding this comment.
Hi @clebergnu, thanks for the quick fix. This is a very interesting issue and I have learned something new today.
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.
Because some tools, such as pylint, will mimic the import of Python modules, they can get confused on the test directory structure, and confuse it with the file containing the module implementation.
For instance, because there is currently:
And:
Pylint may consider the later to be the former. Because we don't need the
autilscomponent in the tests directory, and because it's not expected that this repo will contain anything other than module implementations under the "autils" component, the simplest solution is to drop it.For consistency, this also drops it from the metadata directory.