Bugs:

# Original (correct) import
from collections.abc import Iterable

# Changed automatically to a wrong
from ..abc import Iterable

# Original (correct) import
from google.cloud import vision

# Changed automatically to a wrong
from .cloud import vision

Project structure:

project/
    src/
        collections/
            foo/
            bar/
        google/
            spam/
            eggs/

As you see, if a sub-directory matches 3rd-party package or Python module, the 'absolufy-imports' makes mistakes.

Possible solutions

• Check that import is a 3rd-party package. Do not make such imports relative.
• Another possible solution is to allow to ignore manually specific names. For example, I will ignore names "collections" and "google".

…absolute import paths

Using the below command you just need to specify the package name on which: absolufy-imports - will walk and convert relative import paths to absolute import python paths.

$ absolufy-imports --package your_package_name

No need to specify the module using this command.

The issue I found was that absolufy-imports didn't converted from from ..n2_module import func3 to from package.n2.n2_module import func3 as it should, the import was converted to from n2.n2_module import func3.

The changes don't affect the current setup.

package.zip

absolufy-imports 0.3.0 cannot parse a python file with a BOM.

For example, download bom.py.txt and rename it bom.py (this is a necessary step on GitHub as only *.txt files can be attached), move it into an example project (e.g. src), see the following:

$ cat src/bom.py
import sys
$ file src/bom.py	
src/bom.py: UTF-8 Unicode (with BOM) text
$ python src/bom.py
$ absolufy-imports src/bom.py
Traceback (most recent call last):
  File "/tmp/py310/bin/absolufy-imports", line 8, in <module>
    sys.exit(main())
  File "/tmp/py310/lib/python3.10/site-packages/absolufy_imports.py", line 208, in main
    absolute_imports(
  File "/tmp/py310/lib/python3.10/site-packages/absolufy_imports.py", line 151, in absolute_imports
    tree = ast.parse(txt)
  File "/opt/python-3.10.0/lib/python3.10/ast.py", line 50, in parse
    return compile(source, filename, mode, flags,
  File "<unknown>", line 1
    import sys
    ^
SyntaxError: invalid non-printable character U+FEFF

Perhaps a better message could help? Or try to compare these two uses reading the source file, the last with encoding='utf-8-sig':

$ python -c "from ast import parse; from pathlib import Path; parse(Path('src/bom.py').read_text())"
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/opt/python-3.10.0/lib/python3.10/ast.py", line 50, in parse
    return compile(source, filename, mode, flags,
  File "<unknown>", line 1
    import sys
    ^
SyntaxError: invalid non-printable character U+FEFF
$ python -c "from ast import parse; from pathlib import Path; parse(Path('src/bom.py').read_text(encoding='utf-8-sig'))"
$ 

Hello Marco,

Thank you for great tool. It very helps me to keep source clean.

I have a question and\or suggestion. Is it possible to add command-line argument to make keep-submodules-relative works on init.py files only?

It is very common to use init.py file as a facade to classes and functions from the module, and abosolute imports are quiet annoying here:

# my_application/package/another_package/__init__.py
from .foo import bar
from .foo1 import bar1

vs

# my_application/package/another_package/__init__.py
from my_application.package.another_package.foo import bar
from my_application.package.another_package.foo1 import bar1

https://github.com/NVIDIA/cuda-python/issues/38

I did

(cython) nyck33@nyck33-IdeaPad-Gaming-3-15ACH6:~/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction$ python clock_nvrtc_test.py
Traceback (most recent call last):
  File "/home/nyck33/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction/clock_nvrtc_test.py", line 10, in <module>
    from examples.common import common
ModuleNotFoundError: No module named 'examples'
(cython) nyck33@nyck33-IdeaPad-Gaming-3-15ACH6:~/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction$ ls
clock_nvrtc_test.py  simpleCubemapTexture_test.py  simpleZeroCopy_test.py     vectorAddDrv_test.py
__init__.py          simpleP2P_test.py             systemWideAtomics_test.py  vectorAddMMAP_test.py
(cython) nyck33@nyck33-IdeaPad-Gaming-3-15ACH6:~/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction$ absolufy-imports clock_nvrtc_test.py
(cython) nyck33@nyck33-IdeaPad-Gaming-3-15ACH6:~/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction$ absolufy-imports clock_nvrtc_test.py
(cython) nyck33@nyck33-IdeaPad-Gaming-3-15ACH6:~/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction$ python clock_nvrtc_test.py
Traceback (most recent call last):
  File "/home/nyck33/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction/clock_nvrtc_test.py", line 10, in <module>
    from examples.common import common
ModuleNotFoundError: No module named 'examples'
(cython) nyck33@nyck33-IdeaPad-Gaming-3-15ACH6:~/Documents/cuda-start-dec2022/cuda-python/examples/0_Introduction$ 

Hello!

Awesome project - I was very happy when found it, and this is a really time saver :)

I have a Django project with a following structure:

server
├── Dockerfile
├── action_requests (package)
├── config (package)
├── manage.py
├── persons (package)

While using this amazing tool I faced with a problem when I tried to pass a whole directory of project to absolufy-imports and this caused problems:

▶ absolufy-imports server
Traceback (most recent call last):
  File "/Users/artinnok/Library/Caches/pypoetry/virtualenvs/backend-6XZmvTyF-py3.9/bin/absolufy-imports", line 8, in <module>
    sys.exit(main())
  File "/Users/artinnok/Library/Caches/pypoetry/virtualenvs/backend-6XZmvTyF-py3.9/lib/python3.9/site-packages/absolufy_imports.py", line 208, in main
    absolute_imports(
  File "/Users/artinnok/Library/Caches/pypoetry/virtualenvs/backend-6XZmvTyF-py3.9/lib/python3.9/site-packages/absolufy_imports.py", line 149, in absolute_imports
    with open(file, encoding='utf-8') as fd:
IsADirectoryError: [Errno 21] Is a directory: 'server'

Then I tried to do the same with package action_requests inside server project and faced with same issue.

In every package I have about 15-20 Python files and it is tedious to run absolufy-imports on every file of package :((( Is it possible to add support for folders / packages in future?

Thanks for great tool.

P.S. I think this will force me to write something like a bash-wrapper around absolufy-imports :((

At Astropy we are considering adopting absolute imports (https://github.com/astropy/astropy/issues/14021) but may not be ready to go all in. An option to only absolufy level-up imports, like from ..import <> would be greatly appreciated!

updates:

• github.com/asottile/setup-cfg-fmt: v2.1.0 → v2.2.0
• github.com/pre-commit/mirrors-autopep8: v1.7.0 → v2.0.0
• github.com/asottile/reorder_python_imports: v3.8.5 → v3.9.0
• github.com/asottile/pyupgrade: v3.1.0 → v3.2.0

Hello, @MarcoGorelli Thank you for the project, very cool! 👍

We would like to suggest this feature which will provide a fine-grained control for absolufying imports.

Feature:

• add --depth N option (default to 0, normal behavior)

For example:

• with --depth 1 you can specify to absolufy from .. import X and to keep from . import X. --depth 1 meaning we keep at least 1 level of relative import
  • Keep from . or from .foo
  • Absolufy: from .. or from .foo.bar

This setting allows (for example) to build architectures of packages using only 1 level of relative imports.

We are opened to suggestions so don't hesitate to request any change.

updates:

• github.com/asottile/setup-cfg-fmt: v2.0.0 → v2.1.0
• github.com/asottile/reorder_python_imports: v3.8.2 → v3.8.5
• github.com/asottile/add-trailing-comma: v2.2.3 → v2.3.0
• github.com/asottile/pyupgrade: v2.37.3 → v3.1.0
• github.com/pre-commit/mirrors-mypy: v0.971 → v0.982

I would love to use your module but it is lacking something essential IMO: allow relative imports inside the same folder, i.e, allow from .a import b but not allow from ..a import b.

Most people find it more legible to reference siblings files relatively as you can see/list them. However, as soon as the import to parent folders, it becomes very difficult to read, specially from ............a import b

maybe we could add a relative_level: int to the settings, with

• 0 meaning replace all relative imports
• 1 meaning keep only single dot (ex from .a import b)
• 2 meaning keep up to two dots (ex from ..a import b)
• etc...

Enable support for pyi files when using absolufy-imports through pre-commit. This will run absolufy-imports on stub files in addition to source files.

References:

1. The same file on black
2. pre-commit docs
3. Same PR on pyupgrade
4. Same PR on flake8