Typing #192
Merged
Typing #192
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
We add a mypy.ini file which essentially ignores import errors for some third-party packages that do not provide type hints.
This silents the following errors when running 'mypy':
blessed/__init__.py:13: error: Incompatible import of "Terminal" (imported name has type "Type[blessed.terminal.Terminal]", local name has type "Type[blessed.win_terminal.Terminal]")
blessed/_capabilities.py:9: error: Name 'OrderedDict' already defined (possibly by an import)
Stub files were initially generated using stubgen tool (from mypy), then completed based on signatures and documentation and finally adjusted to achieve 'mypy --strict blessed/' success and limit errors with 'mypy --check-untyped-defs tests/'. Type annotation for formatter's object's __call__() method is a bit special. We make sure that all of them declares accepting arguments of type Union[int, str] though some of them only actually accepts either int or str argument. This is so that the return value of Terminal.__getattr__() is an object with a consistent interface. This is implemented using overloads and we use the special NoReturn to indicate invalid input type.
In tox, we add a 'mypy' environment to run mypy in strict mode on blessed/ directory. In travis-ci, we run the 'mypy' environment for python 3.8.
This avoids a mypy error when using sys.exc_info() as this may return None.
This helps when running mypy on tests/. We add the annotation as a comment for Python 2 compatibility.
Calling a ParameterizingString instance with a string raises a TypeError. In test_formatters.py::test_tparm_returns_null(), it does not because curses.tparm() is monkey-patched but it seems cleaner to use the proper argument type.
Codecov Report
@@ Coverage Diff @@
## master #192 +/- ##
=======================================
Coverage 95.32% 95.32%
=======================================
Files 9 9
Lines 1006 1006
Branches 160 160
=======================================
Hits 959 959
Misses 44 44
Partials 3 3
Continue to review full report at Codecov.
|
|
Not sure we need a mypy.ini when those statements can go in setup.cfg |
|
Excellent work, thank you. |
|
Not sure we need a mypy.ini when those statements can go in setup.cfg
That'd be fine as well. So, do you want this to be changed?
|
That's my preference to reduce the number of files in the root, but @jquast may feel differently. Unrelated, it looks like the error with 3.10 will be fixed in the next release of six. |
jquast
approved these changes
Feb 24, 2021
|
I've moved it to setup.cfg it will be in next release, thank you again |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This adds type annotations and declares the packages as "typed" as proposed in #190. Only the public API is typed.
Typing is checked with mypy in strict mode as far as the blessed/ directory is concerned. Checks are added in tox and travis-ci.
Last commits contain small changes to help type checking in the tests suite.
Running
mypy --check-untyped-defs tests/report some type "errors", most of which are not real errors (e.g. access to a private/untyped attribute or missing assertions).Fix #190.