Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add some more plugin docs #6618

Merged
merged 2 commits into from
Apr 5, 2019
Merged

Add some more plugin docs #6618

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23e34a2
Add some more plugin docs
msullivan Apr 3, 2019
e111fa1
Update extending_mypy.rst
msullivan Apr 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/source/extending_mypy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,11 @@ new first class kinds of types.
The plugin system is experimental and prone to change. If you want to write
a mypy plugin, we recommend you start by contacting the mypy core developers
on `gitter <https://gitter.im/python/typing>`_. In particular, there are
no guarantees about backwards compatibility. Backwards incompatible changes
may be made without a deprecation period.
no guarantees about backwards compatibility.

Backwards incompatible changes may be made without a deprecation period,
but we will announce them in
`the plugin API changes announcement issue <https://github.com/python/mypy/issues/6617>`_.

Configuring mypy to use plugins
*******************************
Expand Down Expand Up @@ -227,3 +230,8 @@ method resolution order, etc.)

**get_customize_class_mro_hook()** can be used to modify class MRO (for example
insert some entries there) before the class body is analyzed.

**get_additional_deps()** can be used to add new dependencies for a
module. It is called before semantic analysis. For example, this can
be used if a library has dependencies that are dynamically loaded
based on configuration information.