python / python/mypy

Expose the proper plugin in the published mypy version

Open
#10,306 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature topic-plugins
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature
The misc/proper_plugin.py is currently not packaged with mypy. Can we expose it as part of mypy itself?

Pitch
I think it would be wise to have a single source of truth for the proper_plugin.py. As the mypy project already uses it to validate internal plugins like the dataclasses, it should stay up to date. Some projects copy the file to their project, but that can cause confusing from not being up to date (i.e. https://github.com/python/mypy/issues/8047#issuecomment-560124874). I think externally developed plugins could benefit from the plugin. So perhaps exposing it as mypy.misc.proper_plugin?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with misc/proper_plugin.py and the requested mypy.misc.proper_plugin import path. Check how mypy's published package currently includes modules and determine what packaging change is needed. Done means the proper plugin is available through the published mypy package without requiring projects to copy it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.