Add path to sys.path vs. PEP E402

Question

In order to import a project specific module somewhere located on your disk, one can easily append this directory to sys.path:

import sys
sys.path.append(some_module_path)

import some_module

However, the latter import now violates PEP E402 ("module level import not at top of file"). At least spyder tells me so. Is spyder here too picky?

In spyder there is the principal idea of a "project", where I assumed environments can be adjusted specific for this project. However, I have no clue, how to modify e.g. the sys.path depending on a spyder project.

How can I modify sys.path in a spyder project? Or is there a general python way of solving this issue?

Answer 1

You could put the sys.path extension in a separate module, e.g. _paths.py.

Contents of _paths.py:

import sys

sys.path.append(some_module_path)
sys.path.append(some_other_module_path)
# ...and so on...

And then in your main application:

import sys

import _paths
import some_module

some_module.some_func()

This solution puts your "project configuration" nicely in a single place (which makes it easy to maintain in the future), and complies with at least PEP8 (including E402) and pylint rules.

Answer 2

As alternative solution to the answer with a separate module if found this as working solution for me.

try:
    sys.path.append(Path(__file__).parent.parent)
except IndexError:
    pass

If I just use the sys.path.append(...), I get the warning, but using the try-catch block does not produce a warning.