PR: Add the PYTHONPATH environment from manager to the pylint

[znapy]

Description of Changes

Add the PYTHONPATH environment from pythonpath-manager to the pylint plugin to access the root of the project without packages.

Example:

Suppose, you have a project with a single script (for simplicity in a spyder environment):

my-project
| - do_something.py

and you write a test:

my-project
| - do_something.py
| - tests
  | - test_do_something.py

In test_do_something.py you access to import do_something. So if you start Source -> Run code analysis it will show the error Unable to import 'do_something'. But in the IPython console !pytest tests/test_do_something.py doesn't show this error because there is PYTHONPATH environment.

And you should take additional steps to solve this problem, for example, make a packages:

my-project
| - my_project
  | - __init__.py
  | - do_something.py
  | - tests
    | - __init__.py
    | - test_do_something.py

or fix paths in pylintrc or pyproject.toml (section [tool.pylint], value init-hook=...):

my-project
| - do_something.py
| - tests
  | - test_do_something.py
| - pyproject.toml

No hacks are needed with this PR - it works out of the box.

Affirmation

By submitting this Pull Request or typing my (user)name below,
I affirm the Developer Certificate of Origin
with respect to all commits and content included in this PR,
and understand I am releasing the same under Spyder's MIT (Expat) license.

I certify the above statement is true and correct: @Znapy

[pep8speaks]

Hello @znapy! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2024-04-24 20:22:03 UTC