[Code scan] Pyright configuration excludes most format and plugin modules
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
Research direction
Inspect the [tool.pyright] section at lines 131-134 of pyproject.toml, then compare its include pattern with the nested files listed by git ls-files dpdata '*.py'. Done means nested modules under dpdata/formats, dpdata/plugins, and dpdata/md are covered by Pyright, or the exclusion is explicitly documented.
Written by the indexing model from the issue text.
Description
This issue is part of a Codex global repository code scan.
The Pyright configuration only includes top-level dpdata/*.py files. Most implementation code lives in nested packages under dpdata/formats, dpdata/plugins, and dpdata/md, so the type-check workflow has limited coverage of the format/plugin code paths where most parsers and writers live.
Affected config:
https://github.com/deepmodeling/dpdata/blob/a7a50bfc096e1a65470af6f1c48152dc0275ec1c/pyproject.toml#L131-L134
Current configuration:
[tool.pyright]
include = [
"dpdata/*.py",
]
Repository shape from git ls-files dpdata '*.py' shows many nested modules outside this include pattern, including all parser/writer modules under dpdata/formats and registry modules under dpdata/plugins.
Suggested improvement: expand Pyright coverage to include nested package modules, or explicitly document why nested format/plugin modules are excluded.
- Dominant language
- Python
- Stars
- 254
- Forks
- 159
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from deepmodeling/dpdata
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
deepmodeling/dpdata#1058 ·
-
feature request qe
Difficulty 3/5 1-2 days Newbie friendliness 45/100
deepmodeling/dpdata#901 · 4 comments ·
-
enhancement vasp
Difficulty 4/5 3-5 days Newbie friendliness 38/100
deepmodeling/dpdata#642 ·
-
enhancement lammps
Difficulty 4/5 3-5 days Newbie friendliness 25/100
deepmodeling/dpdata#609 · 1 comment ·
-
awaiting response bug vasp
Difficulty 4/5 3-5 days Newbie friendliness 35/100
deepmodeling/dpdata#566 · 2 comments ·
All issues in deepmodeling/dpdata
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100