Add support for per-plugin options
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
The issue names no implementation files, entry points, or tests. Start by reviewing the three configuration proposals and the existing plugin registration and option-parsing behavior, then establish which convention is accepted and how plugin options and the mypy version should be exposed before defining completion criteria.
Written by the indexing model from the issue text.
Description
Starting discussion from #3517 in a new issue.
Some plugins may want to expose user-configurable options. For example, with my docstring parser I want users to be able to specify which style of docstrings to expect (the default behavior of automatic discovery is a bit slower).
To accomplish this we define a convention for plugins to provide options within mypy.ini, and pass the parsed options as Dict[str, str] to the plugin() registration function, along with the mypy version. User plugins will need to do their own conversion of options from str to bool, int, float, etc.
Here are three proposals for how to link plugin registration with per-plugin configuration options:
Option A
The correlation here is bit fragile and the per-plugin section headers may be difficult to grok for longer (i.e. absolute) paths:
[mypy]
fast_parser = true
plugins = /path/to/typeddict.py, /path/to/mypydoc.py
[mypy.plugins-/path/to/mypydoc.py]
docstring_style = 'google'
Option B
The following is visually clean, but can't as easily piggy-back on the current options-parsing code. (Note: I believe that mypy-plugins with a dash would conflict with mypy's per-module configuration):
[mypy]
fast_parser = true
[mypy.plugins]
typeddict = /path/to/typeddict.py
mypydoc = /path/to/mypydoc.py
[mypy.plugins-mypydoc]
docstring_style = 'google'
Option C
The following dotted registration style is used heavily by mercurial, and this is what I decided on in my implementation. It piggy-backs existing options parsing code, so it could easily be extended to per-module options in the future, if we found a need for that:
[mypy]
fast_parser = true
plugins.typeddict = /path/to/typeddict.py
plugins.mypydoc = /path/to/mypydoc.py
[mypy.plugins-mypydoc]
docstring_style = 'google'
I tried to come up with some logic for the separators:
- periods join known mypy sections: e.g.
[mypy],[mypy.plugins] - dashes join sections with dynamic topics: e.g.
[mypy.plugins-custom.plugin],[mypy-custom.module]
I'm completely open to other suggestions. Underscore could work in place of periods, but I found it less visually appealing.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 54
Contributor guide
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 python/mypy
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug topic-configuration topic-error-reporting
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100