🧹 Path from ROOT_DIR instead of __file__/..
#6353
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
github-project-automation
bot
added this to
Hedy organization board and Newsletter content
Kache
force-pushed
the
centralize-filepaths
branch
3 times, most recently
from
a219b24 to
1974a96
Compare
"Pathing up" via `__file__` (e.g. `../`) is fragile, so only do it in a centrally-defined `config.ROOT_DIR`, and path from root everywhere else Also fix improper Python exec-as-module vs exec-as-script in `dodo.py`. Needing to modify `sys.path` in order to import is a sign of having used the wrong variant. For readers, a rule of thumb: * `python foo/bar.py` - independent, only depends on contents of `foo` * `python -m foo.bar` - depends on project modules outside of `foo` These changes also facilitate a future migration towards the cleaner [src layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/) In the future, this can be enforced with custom pylint checks, which is easier to add after migrating the project to use `pyproject.toml` instead of `requirements.txt`
Kache
force-pushed
the
centralize-filepaths
branch
from
1974a96 to
6843255
Compare
AnneliesVlaar
moved this from Review for relevance
to Not newsletter material
in Newsletter content
rix0rrr
force-pushed
the
main
branch
6 times, most recently
from
674bb9f to
207fc8b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
"Pathing up" via
__file__(e.g.../) is fragile, so only do it in acentrally-defined
config.ROOT_DIR, and path from root everywhere elseAlso fix improper Python exec-as-module vs exec-as-script in
dodo.py.Needing to modify
sys.pathin order to import is a sign of having usedthe wrong variant. For readers, a rule of thumb:
python foo/bar.py- independent, only depends on contents offoopython -m foo.bar- depends on project modules outside offooThese changes also facilitate a future migration towards the cleaner
src layout
In the future, this can be enforced with custom pylint checks, which is
easier to add after migrating the project to use
pyproject.tomlinstead of
requirements.txt