Replace relative imports for imports outside of the immediate module #1738
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.
Following a discussion on the developer catch-up, we decided it would be good practice to only use relative imports within the immediate module, e.g.
in etna.articles.blocks.py, this is fine:
from .models import ArticlePage
but we shouldn't use them like this:
from ..media.blocks import MediaBlock
and should instead be writing:
from etna.media.blocks import MediaBlock
It adds unnecessary additional cognitive load. The two apps are not immediately related to one another -
etna.media
can exist withoutetna.articles
(in theory). So there is a chance that the path may change. It also makes it easier to trace where you are importing things from, and makes it clear to a developer trying to understand your code."Explicit is better than implicit."