Title: Add support for per-plugin options · Issue #3532 · python/mypy · GitHub
Open Graph Title: Add support for per-plugin options · Issue #3532 · python/mypy
X Title: Add support for per-plugin options · Issue #3532 · python/mypy
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 ...
Open Graph 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 doc...
X 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 doc...
Opengraph URL: https://github.com/python/mypy/issues/3532
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Add support for per-plugin options","articleBody":"Starting discussion from #3517 in a new issue.\r\n\r\n\r\nSome 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). \r\n\r\nTo 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.\r\n\r\nHere are three proposals for how to link plugin registration with per-plugin configuration options:\r\n\r\n--- \r\n\r\n**Option A**\r\n\r\nThe correlation here is bit fragile and the per-plugin section headers may be difficult to grok for longer (i.e. absolute) paths:\r\n```ini\r\n[mypy]\r\nfast_parser = true\r\nplugins = /path/to/typeddict.py, /path/to/mypydoc.py\r\n\r\n[mypy.plugins-/path/to/mypydoc.py]\r\ndocstring_style = 'google'\r\n```\r\n\r\n---\r\n\r\n**Option B**\r\n\r\nThe 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):\r\n```ini\r\n[mypy]\r\nfast_parser = true\r\n\r\n[mypy.plugins]\r\ntypeddict = /path/to/typeddict.py\r\nmypydoc = /path/to/mypydoc.py\r\n\r\n[mypy.plugins-mypydoc]\r\ndocstring_style = 'google'\r\n```\r\n\r\n---\r\n\r\n**Option C**\r\n\r\nThe 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:\r\n```ini\r\n[mypy]\r\nfast_parser = true\r\nplugins.typeddict = /path/to/typeddict.py\r\nplugins.mypydoc = /path/to/mypydoc.py\r\n\r\n[mypy.plugins-mypydoc]\r\ndocstring_style = 'google'\r\n```\r\n\r\n---\r\n\r\nI tried to come up with some logic for the separators:\r\n - periods join known mypy sections: e.g. `[mypy]`, `[mypy.plugins]`\r\n - dashes join sections with dynamic topics: e.g. `[mypy.plugins-custom.plugin]`, `[mypy-custom.module]`\r\n\r\n\r\nI'm completely open to other suggestions. Underscore could work in place of periods, but I found it less visually appealing.","author":{"url":"https://github.com/chadrik","@type":"Person","name":"chadrik"},"datePublished":"2017-06-13T16:31:55Z","url":"https://github.com/python/mypy/issues/3532"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:3257c2cd-441a-e6b2-17e3-ae2165e39b4b |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A342:30501:B1E6E1:EFDE74:6B004DB7 |
| html-safe-nonce | 1f6372e20dd2827a856903a335afcf8c33f31b884609ae029fb49feeeac209af |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMzQyOjMwNTAxOkIxRTZFMTpFRkRFNzQ6NkIwMDREQjciLCJ2aXNpdG9yX2lkIjoiMzQwOTY3OTUwMzM0ODIyMzQxNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 92b9e5fa8cf96eadba93644891d867743af8e8542c633dabd4da528c9f8ce12a |
| hovercard-subject-tag | issue:235614112 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/mypy/3532/issue_layout |
| twitter:image | https://opengraph.githubassets.com/22ae64367c2a1cf44e6d392cfe837aac13b62f58c9ab4d7dae7a71b8a74decd9/python/mypy/issues/3532 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/22ae64367c2a1cf44e6d392cfe837aac13b62f58c9ab4d7dae7a71b8a74decd9/python/mypy/issues/3532 |
| og:image:alt | 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 doc... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | chadrik |
| hostname | github.com |
| expected-hostname | github.com |
| None | f9517bf360d46638a1e5e7daee7158842fe5ef43c9000afa0e127564a7c2f39b |
| turbo-cache-control | no-preview |
| go-import | github.com/python/mypy git https://github.com/python/mypy.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 7053637 |
| octolytics-dimension-repository_nwo | python/mypy |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 7053637 |
| octolytics-dimension-repository_network_root_nwo | python/mypy |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | b27c5dde30676028abd5c5fc53ce5c9b625f8281 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width