Missing imports (pyright) of a custom package and mypy not working.

[ubaldot]

I have just installed mypy and pyright and it feels like that I am almost there.
However, I have a couple of problems:

1. pyright does not seem to recognize the package I am developing. I am located in the right folder because if send import <my_package> as <something> to a REPL then it is recognized and I can use the classes and functions therein defined.
2. mypy won't recognize the option -p <my package>. However, if I run mypy -p <my_package> from the terminal (Anaconda powershell on Windows 10) it works fine.

Inspection of :ALEDebugInfo (below) looks promising for both the issues. It feels that I am almost there but I cannot get there yet... I need some hint.

 Current Filetype: python
Available Linters: ['bandit', 'cspell', 'flake8', 'flakehell', 'jedils', 'mypy', 'prospector', 'pycodestyle', 'pydocstyle', 'pyflakes', 'pylama', 'pylint', 'pylsp', 'pyre', 'pyright', 'unimport', 'vulture']
  Enabled Linters: ['flake8', 'mypy', 'pycodestyle', 'pyright']
  Ignored Linters: []
 Suggested Fixers: 
  'add_blank_lines_for_python_control_statements' - Add blank lines before control statements.
  'autoflake' - Fix flake issues with autoflake.
  'autoimport' - Fix import issues with autoimport.
  'autopep8' - Fix PEP8 issues with autopep8.
  'black' - Fix PEP8 issues with black.
  'isort' - Sort Python imports with isort.
  'pyflyby' - Tidy Python imports with pyflyby.
  'remove_trailing_lines' - Remove all blank lines at the end of a file.
  'reorder-python-imports' - Sort Python imports with reorder-python-imports.
  'trim_whitespace' - Remove all trailing whitespace characters at the end of every line.
  'yapf' - Fix Python files with yapf.
 Linter Variables:

let g:ale_python_auto_pipenv = 1
let g:ale_python_auto_poetry = 0
let g:ale_python_black_options = '--line-length=89'
let g:ale_python_flake8_auto_pipenv = 0
let g:ale_python_flake8_auto_poetry = 0
let g:ale_python_flake8_change_directory = 'project'
let g:ale_python_flake8_executable = 'flake8'
let g:ale_python_flake8_options = '--ignore=E501'
let g:ale_python_flake8_use_global = 0
let g:ale_python_mypy_auto_pipenv = 0
let g:ale_python_mypy_auto_poetry = 0
let g:ale_python_mypy_executable = 'mypy'
let g:ale_python_mypy_ignore_invalid_syntax = 0
let g:ale_python_mypy_options = '-p dymoval'
let g:ale_python_mypy_show_notes = 1
let g:ale_python_mypy_use_global = 0
let g:ale_python_pycodestyle_auto_pipenv = 0
let g:ale_python_pycodestyle_auto_poetry = 0
let g:ale_python_pycodestyle_executable = 'pycodestyle'
let g:ale_python_pycodestyle_options = ''
let g:ale_python_pycodestyle_use_global = 0
let g:ale_python_pyright_config = {}
let g:ale_python_pyright_executable = 'pyright-langserver'
 Global Variables:

let g:ale_cache_executable_check_failures = v:null
let g:ale_change_sign_column_color = 0
let g:ale_command_wrapper = ''
let g:ale_completion_delay = 100
let g:ale_completion_enabled = 1
let g:ale_completion_max_suggestions = 50
let g:ale_disable_lsp = 0
let g:ale_echo_cursor = 1
let g:ale_echo_msg_error_str = 'Error'
let g:ale_echo_msg_format = '%code: %%s'
let g:ale_echo_msg_info_str = 'Info'
let g:ale_echo_msg_warning_str = 'Warning'
let g:ale_enabled = 1
let g:ale_fix_on_save = 1
let g:ale_fixers = {'c': ['clang-format', 'remove_trailing_lines', 'trim_whitespace'], 'cpp': ['clang-format'], 'python': ['remove_trailing_lines', 'trim_whitespace', 'autoflake', 'black']}
let g:ale_history_enabled = 1
let g:ale_history_log_output = 1
let g:ale_keep_list_window_open = 0
let g:ale_lint_delay = 200
let g:ale_lint_on_enter = 1
let g:ale_lint_on_filetype_changed = 1
let g:ale_lint_on_insert_leave = 1
let g:ale_lint_on_save = 1
let g:ale_lint_on_text_changed = 'normal'
let g:ale_linter_aliases = {}
let g:ale_linters = {'c': ['clangd', 'cppcheck', 'gcc'], 'python': ['flake8', 'pyright', 'mypy', 'pycodestyle']}
let g:ale_linters_explicit = 0
let g:ale_linters_ignore = {}
let g:ale_list_vertical = 0
let g:ale_list_window_size = 10
let g:ale_loclist_msg_format = '%code: %%s'
let g:ale_max_buffer_history_size = 20
let g:ale_max_signs = -1
let g:ale_maximum_file_size = v:null
let g:ale_open_list = 0
let g:ale_pattern_options = v:null
let g:ale_pattern_options_enabled = v:null
let g:ale_root = {}
let g:ale_set_balloons = 1
let g:ale_set_highlights = 1
let g:ale_set_loclist = 1
let g:ale_set_quickfix = 0
let g:ale_set_signs = 1
let g:ale_sign_column_always = 0
let g:ale_sign_error = '>>'
let g:ale_sign_info = '--'
let g:ale_sign_offset = 1000000
let g:ale_sign_style_error = '>>'
let g:ale_sign_style_warning = '--'
let g:ale_sign_warning = '--'
let g:ale_sign_highlight_linenrs = 0
let g:ale_statusline_format = v:null
let g:ale_type_map = {}
let g:ale_use_global_executables = v:null
let g:ale_virtualtext_cursor = 0
let g:ale_warn_about_trailing_blank_lines = 1
let g:ale_warn_about_trailing_whitespace = 1
  Command History:

(executable check - success) flake8
(finished - exit code 0) 'cmd /s/c "cd /d C:\VAS\tools\python\model_validation\scripts && flake8 --version"'

<<<OUTPUT STARTS>>>
4.9.2 (mccabe: 0.6.1, pycodestyle: 2.7.0, pyflakes: 2.3.1) CPython 3.9.12 on
Windows
<<<OUTPUT ENDS>>>

(executable check - success) mypy
(finished - exit code 2) 'cmd /s/c "cd /d C:\VAS\tools\python\model_validation\scripts && mypy -p dymoval --show-column-numbers --shadow-file C:\VAS\tools\python\model_validation\scripts\test_manual.py C:\Users\yt75534\AppData\Local\Temp\V2M4596.tmp\test_manual.py C:\VAS\tools\python\model_validation\scripts\test_manual.py"'

<<<OUTPUT STARTS>>>
usage: mypy [-h] [-v] [-V] [more options; see below]
            [-m MODULE] [-p PACKAGE] [-c PROGRAM_TEXT] [files ...]
mypy: error: May only specify one of: module/package, files, or command.
<<<OUTPUT ENDS>>>

(executable check - success) pycodestyle
(finished - exit code 0) 'cmd /s/c "pycodestyle  - < C:\Users\yt75534\AppData\Local\Temp\V3F45B7.tmp\test_manual.py"'

<<<NO OUTPUT RETURNED>>>

(executable check - success) pyright-langserver
(finished - exit code 0) 'cmd /s/c "cd /d C:\VAS\tools\python\model_validation\scripts && flake8 --ignore=E501 --format=default --stdin-display-name C:\VAS\tools\python\model_validation\scripts\test_manual.py - < C:\Users\yt75534\AppData\Local\Temp\V4847BB.tmp\test_manual.py"'

<<<NO OUTPUT RETURNED>>>

(started) 'cmd /s/c "pyright-langserver --stdio"'

[hsanson]

1. Maybe adding a configuration file and properly setting the "include" configuration would solve the issue? https://github.com/microsoft/pyright/blob/main/docs/configuration.md#pyright-configuration

2. I do not use mypy myself but it seems that you either check a package, a module, or a file. ALE works on single files so it always adds --shadow-file C:\VAS\...\test_manual.py C:\Users\...\Temp\V2M4596.tmp\test_manual.py C:\VAS\...\test_manual.py to the command that conflicts with the -m flag you are adding. Not much you can do here other than try to work with single file (e.g. remove the -m option).

[ubaldot]

Many thanks!

1. Lot of info there! Many thanks!
2. Ok, that is good to know.

Question: if I am developing a package, how shall I tell vim/ALE/any_LSP the path of such package?
I am developing a package but it seems that it is not reckon. Even trying Omnicomplete cannot find the package, so I suspect it is a Vim issue rather than an ALE issue, correct?

[hsanson]

ALE simply shows whatever the LSP (pyright) returns. Therefore the problem is neither ALE nor Vim/Neovim. You will need to figure out how pyright needs to be configured to find your package. Maybe the "extraPaths" is what you need?

This documentation explains how pyright figures out the imports: https://github.com/Microsoft/pyright/blob/main/docs/import-resolution.md

Appreciated if you share your findings.

[ubaldot]

I spend a big chunk of the morning in trying different solutions, but I could not find any. :(
I checked in :ALEInfo and the options were passed correctly but... the issue was still there.
I will survive without I guess :)

Regarding my point 1. I was thinking that it may be handy to extend ALE so that it can check also at package level and not only at module level, no? :)

[ubaldot]

Update: here is a working configuration:

let g:ale_python_pyright_config = {
  \ 'pyright': {
  \"executionEnvironments": 
  \ {
  \   "root": "C:/PythonStuff/MyProject",
  \   "pythonVersion": "3.10",
  \   "pythonPlatform": "Windows",
  \   "extraPaths": [
  \     "C:/PythonStuff/MyProject/MyPackage"]
  \ },
  \},
  \}

But is is important that you have the same python version supported by your installed vim. :)
I have 3.9 (shipped with Anaconda) but I created a venv with Python 3.10.

[ubaldot]

UPDATE: I was wrong. This config was not working :(

[ubaldot]

PROBLEM (kinda-of) SOLVED
A turnaround to this problem was to install my own package with pip install -e . so it ended up in sys.path automatically and yet I can keep in editing it. :)