Use absolute imports #20
Conversation
- Removes the deprecated `absolutify-imports` package from `.pre-commit` and adds a rule in `pyproject.toml` for `ruff` to handle relative import errors. - Refactors all code that used relative imports.
pyproject.toml
Outdated
| [tool.ruff.lint.flake8-tidy-imports] | ||
| ban-relative-imports = "all" | ||
|
|
There was a problem hiding this comment.
is this different from adding TID252 to the list of selected rules below?
There was a problem hiding this comment.
This I do not know. I used the documentation to update the pyproject.toml file
https://docs.astral.sh/ruff/settings/#lint_flake8-tidy-imports_ban-relative-imports
There was a problem hiding this comment.
I would use both, and move this section below the general tool.ruff.lint this way we'll have all specific configuration of ruff.tool.lint grouped together (there are already pydocstyle and file specific configs). From what I understand, this part is changing the default behaviour of the rule which probably adds it to the list of selected rules under the hood (otherwise configuring it would be pointless) but feels a bit obscure. The docs for the rule: https://docs.astral.sh/ruff/rules/relative-imports/. We can add a comment after the rule explaining what it is like for the others.
|
it looks like it now runs on notebooks within docs which fails the check: https://github.com/arviz-devs/arviz-base/actions/runs/11087276115/job/30805831294?pr=20#step:5:37. I think we can skip ruff for the notebooks in the docs |
|
And nice catch on this: https://github.com/arviz-devs/arviz-base/actions/runs/11087276115/job/30805831294?pr=20#step:5:104 looks like the upgrade is worth it |
- also fix test error
|
woof...pun intended This should refactor the codebase to use absolute imports now. |
absolutify-importspackage from.pre-commitand adds a rule inpyproject.tomlforruffto handle relative import errors.Resolves #19
📚 Documentation preview 📚: https://arviz-base--20.org.readthedocs.build/en/20/