Skip to content

Commit

Permalink
Add some more plugin docs
Browse files Browse the repository at this point in the history
 * Link to plugin changes announcement issue (#6617)
 * Document get_additional_deps()
  • Loading branch information
msullivan committed Apr 3, 2019
1 parent 65757aa commit 23e34a2
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/source/extending_mypy.rst
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 attempt to 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.

0 comments on commit 23e34a2

Please sign in to comment.