E402 triggered after sys.path.append

[remchuk]

Hey there fellows,

I have quite a large python project with flask, with a main app (a directory called A with many directories inside).

In addition to A, I have several directories that are called *_scripts that usually call some functions from the main app( Directory A).

Is this intended? If feel like it is a false positive.

example:

A/
|
---- B/
     |  
     ------- likable.py
---- C/
----- D/
|
cool_scripts/
      |
      ----- nice_script.py

In nice_script.py I have the following:

#!/usr/bin/env python3

import os
import sys

ROOT_DIR = os.path.dirname(os.path.abpath(__file__))
sys.path.append(f"{ROOT_DIR}/../")

from A.B.likable import some_function

but from A.B.likable import some_function prompts E402.

You are much wiser and more experiences people of python, any advice? is it false positive?
I found some similer issues but all of them doesn't seem to solve this issue.

[MichaReiser]

That Ruff triggers E402 on your example does make sense to me. E402 enforces that all imports are at the top of the file. This isn't the case here because of your path-manipulation statements

ROOT_DIR = os.path.dirname(os.path.abpath(__file__))
sys.path.append(f"{ROOT_DIR}/../")

Now, if it isn't important to you that imports are at the top, then I suggest to disable E402 for all files in the scripts directory by using per-file-ignores.

[remchuk]

It is important to me, but I'm unable to import the them before those lines are ran.

I found this pr:
#9047

Shouldn't it solve my problem?
(Its doesn't currently)

[MichaReiser]

Oh nice find. I wasn't aware of this behavior. I had a quick look at the implementation and I suspect the problem is that you have two statements. Can you try inlining ROOT_DIR like this

#!/usr/bin/env python3

import os
import sys

sys.path.append(f"{os.path.dirname(os.path.abpath(__file__))}/../")

from A.B.likable import some_function

[remchuk]

I tried, but it isn't helping.

[remchuk]

Oh nice find. I wasn't aware of this behavior. I had a quick look at the implementation and I suspect the problem is that you have two statements. Can you try inlining ROOT_DIR like this

#!/usr/bin/env python3

import os
import sys

sys.path.append(f"{os.path.dirname(os.path.abpath(__file__))}/../")

from A.B.likable import some_function

I even tried it with Path instead of the os.path.dirname and also to no avail.

[MichaReiser]

I'm unable to reproduce your issue. I see E402 if I paste your original snippet but the error goes away if I paste the snippet from my reply in #15133 (reply in thread) or the snippet that you just shared. Can you share your ruff configuration and how you call Ruff?

[remchuk]

pyproject.toml:

[tool.ruff]
line-length = 140

[tool.ruff.lint]
select = ["ALL"]
ignore = [
     "D",
     "FBT",
     "E501",
     "S311",
]

fixable = ["ALL"]

[tool.ruff.format]
line-ending = "auto"
indent-style = "space"
quota-style = "double"
skip-magic-trailing-comma = "false"

[tool.ruff.lint.isort]
combine-as-imports = true
force-sort-within-sections = true
split-on-trailing-comma = false

I'm using VSCode, so I have the extension installed and the module as well.

setting.json:

{
"ruff.lineLenght": 140,
"ruff.lint.select": [],
"ruff.lint.run": "onSave",
"ruff.configuration": "path/pyproject.toml"
"ruff.enable": true
"ruff.organizeImports": true,
"notebook.defaultFormatter": "charliermarsh.ruff"
"editor.defaultFormatter": "charliermarsh.ruff"
"ruff.configurationPreference": "filesystemFirst"
}