Run without module detection logic
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 20.6k
- フォーク
- 3.3k
- PR マージ指標
- PR 指標を取得中
説明
Feature
Allow mypy --no-module-detection (or similar flag) to run without mypy attempting to map files as modules. For example, linting standalone scripts should not require module detection magic.
Pitch
Mypy has (somewhat confusing?) file-to-module mapping logic explained in https://mypy.readthedocs.io/en/latest/running_mypy.html#mapping-file-paths-to-modules. The key take away is that mypy attempts to determine a module name for each imported file (in various ways). For example, a/b/c.py -> a.b.c.
However, the documentation doesn't give rationale for why this actually needs to be always done. If you merely want to check standalone files like mypy one.py then why does this require determining module name for the file?
(AFAIK, other linters like pylint don't have this kind of magic, perhaps because they don't follow imports like mypy does.)
If we have two files mypy one.py two.py and two imports one, then the detection logic is needed, so that module one is found (and it's fine).
However, if I have sub-directories with similarly named files, doing mypy one/file.py two/file.py throws:
two/file.py: error: Duplicate module named 'file' (also at 'one/file.py')
But these are two standalone files, in separate directories, not part of the same package. Why is the error there?
Similar trouble is faced when maintaining a monorepo with multiple packages:
package1/
setup.py
...
package2/
setup.py
...
Mypy will throw error about duplicate module name on setup.py files (and others).
Now, without arguing on how mypy should determine module name of the files is looks up (surely there's reasoning for that), I'm suggesting to add an option to completely skip this magic. In my case, I always pip install -e . the packages that I'm developing, so whatever imports the code (wherever), those imports are already resolvable. All the packages are already importable and whatever files reside out of the packages, are stand-alone scripts and never imported.
One downside is that something like this would no longer work:
package1/
src/
...
setup.py
tasks.py # imports util.py
util.py
For that I don't have suggestion :( Could it be solved by multiple entries in MYPYPATH or PYTHONPATH?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
issue で説明されている mypy のファイルからモジュールへのマッピング動作から始め、示されているコマンドを使って重複モジュールの例を再現します。スタンドアロンファイル、import されたファイル、複数のパッケージルートに対するオプションの動作を定義します。提案した flag が、必要な import 解決を壊すことなく、望ましくない重複モジュールエラーを回避できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- compilers, devtools
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100