Document how plugins can support the new semantic analyzer #7135
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ilevkivskyi
approved these changes
Jul 2, 2019
mypy/plugin.py
Outdated
| The new semantic analyzer (enabled through the --new-semantic-analyzer flag) | ||
| changes how plugins are expected to work in several notable ways: | ||
|
|
||
| 1. The order of processing modules is different. The old semantic analyzer |
There was a problem hiding this comment.
Maybe say "order of processing statements in modules"? Otherwise people may get confused that just the order of modules in SCC is different and will not read further.
mypy/plugin.py
Outdated
| 1. The order of processing modules is different. The old semantic analyzer | ||
| processed modules in textual order, one module at a time. The new semantic | ||
| analyzer first processes the module top levels, including bodies of any | ||
| top-level classes. Functions and methods are processed only after module |
There was a problem hiding this comment.
Clarify here that "top-level" means not nested in functions/methods. Classes nested in other classes are still processed.
mypy/plugin.py
Outdated
| This also means that function signatures in the same module have not been | ||
| analyzed yet when analyzing the module top level. If you need access to | ||
| a function signature, you'll need to explicitly analyze the signature first | ||
| using `type_anal()`. |
There was a problem hiding this comment.
It is anal_type(), not type_anal().
mypy/plugin.py
Outdated
| to call this if `anal_type` returns None, however. | ||
|
|
||
| 5. There is a new API property `final_iteration`, which is true once the | ||
| maximum semantic analysis iteration count has been reached. You must never |
There was a problem hiding this comment.
Maybe mention this can be also True sooner if mypy detected no progress during last iteration?
| analyzed. | ||
|
|
||
| You can use `api.options.new_semantic_analyzer` to check whether the new | ||
| semantic analyzer is enabled. |
There was a problem hiding this comment.
Should this added info be also added to docs/source/extending_mypy.rst?
ilevkivskyi
approved these changes
Jul 3, 2019
JukkaL
added a commit
that referenced
this pull request
Jul 5, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Work towards #7071 (and more).