Skip to content

Commit 23e34a2

Browse files
committed
Add some more plugin docs
* Link to plugin changes announcement issue (#6617) * Document get_additional_deps()
1 parent 65757aa commit 23e34a2

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/source/extending_mypy.rst

+10-2
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,11 @@ new first class kinds of types.
5959
The plugin system is experimental and prone to change. If you want to write
6060
a mypy plugin, we recommend you start by contacting the mypy core developers
6161
on `gitter <https://gitter.im/python/typing>`_. In particular, there are
62-
no guarantees about backwards compatibility. Backwards incompatible changes
63-
may be made without a deprecation period.
62+
no guarantees about backwards compatibility.
63+
64+
Backwards incompatible changes may be made without a deprecation period,
65+
but we will attempt to announce them in
66+
`the plugin API changes announcement issue <https://github.com/python/mypy/issues/6617>`_.
6467

6568
Configuring mypy to use plugins
6669
*******************************
@@ -227,3 +230,8 @@ method resolution order, etc.)
227230

228231
**get_customize_class_mro_hook()** can be used to modify class MRO (for example
229232
insert some entries there) before the class body is analyzed.
233+
234+
**get_additional_deps()** can be used to add new dependencies for a
235+
module. It is called before semantic analysis. For example, this can
236+
be used if a library has dependencies that are dynamically loaded
237+
based on configuration information.

0 commit comments

Comments
 (0)