Fill missing type hints #241

eggplants · 2022-03-02T14:52:36Z

Closes: #240

typeguard.typechecking is too complex to annotate correctly. So please tell me your advice, or annotate it instead of me.

$ mypy src
src/typeguard/__init__.py:1133: error: Function is missing a return type
annotation  [no-untyped-def]
    def typechecked(func=None, *, always=False, _localns: Optional[Dict[st...
    ^
src/typeguard/__init__.py:1133: error: Function is missing a type annotation
for one or more arguments  [no-untyped-def]
    def typechecked(func=None, *, always=False, _localns: Optional[Dict[st...
    ^
src/typeguard/__init__.py:1164: error: No overload variant of "typechecked"
matches argument types "Union[FunctionType, MethodType, Type[Any]]", "Any",
"Dict[str, Any]"  [call-overload]
                            typechecked(attr, always=always, _localns=func...
                            ^
src/typeguard/__init__.py:1164: note: Possible overload variants:
src/typeguard/__init__.py:1164: note:     def typechecked(*, always: bool = ...) -> Callable[[T_CallableOrType], T_CallableOrType]
src/typeguard/__init__.py:1164: note:     def [T_CallableOrType] typechecked(func: T_CallableOrType, *, always: bool = ...) -> T_CallableOrType
src/typeguard/__init__.py:1168: error: No overload variant of "typechecked"
matches argument types "Callable[..., Any]", "Any", "Dict[str, Any]" 
[call-overload]
                        wrapped = typechecked(attr.__func__, always=always...
                                  ^
src/typeguard/__init__.py:1168: note: Possible overload variants:
src/typeguard/__init__.py:1168: note:     def typechecked(*, always: bool = ...) -> Callable[[T_CallableOrType], T_CallableOrType]
src/typeguard/__init__.py:1168: note:     def [T_CallableOrType] typechecked(func: T_CallableOrType, *, always: bool = ...) -> T_CallableOrType
src/typeguard/__init__.py:1174: error: Argument 3 to "getattr" has incompatible
type "Tuple[]"; expected "bool"  [arg-type]
    ...ty_func is not None and getattr(property_func, "__annotations__", ()):
                                                                         ^
src/typeguard/__init__.py:1175: error: No overload variant of "typechecked"
matches argument types "Any", "Any", "Dict[str, Any]"  [call-overload]
                            kwargs[name] = typechecked(
                                           ^
src/typeguard/__init__.py:1175: note: Possible overload variants:
src/typeguard/__init__.py:1175: note:     def typechecked(*, always: bool = ...) -> Callable[[T_CallableOrType], T_CallableOrType]
src/typeguard/__init__.py:1175: note:     def [T_CallableOrType] typechecked(func: T_CallableOrType, *, always: bool = ...) -> T_CallableOrType
src/typeguard/__init__.py:1179: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any], Any]]"  [arg-type]
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1179: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any, Any], None]]"  [arg-type]
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1179: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any], None]]"  [arg-type]
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1219: error: Returning Any from function declared to
return
"Union[TypeCheckedGenerator, TypeCheckedAsyncGenerator, GeneratorType[Any, Any, Any]]"
 [no-any-return]
            return retval
            ^
Found 10 errors in 1 file (checked 3 source files)

eggplants · 2022-03-02T14:55:30Z

@agronholm .pre-commit-config.yaml is not found.

agronholm · 2022-03-02T14:59:14Z

I haven't added the pre-commit configuration to this project yet.

agronholm · 2022-03-02T15:00:05Z

Why have you added all sorts of unrelated configuration?

eggplants · 2022-03-02T15:02:36Z

Why have you added all sorts of unrelated configuration?

Sorry, removed.

agronholm · 2022-03-02T15:09:21Z

Closes: #240

typeguard.typechecking is too complex to annotate correctly. So please tell me your advice, or annotate it instead of me.

$ mypy src
src/typeguard/__init__.py:1133: error: Function is missing a return type
annotation  [no-untyped-def]
    def typechecked(func=None, *, always=False, _localns: Optional[Dict[st...
    ^
src/typeguard/__init__.py:1133: error: Function is missing a type annotation
for one or more arguments  [no-untyped-def]
    def typechecked(func=None, *, always=False, _localns: Optional[Dict[st...
    ^
src/typeguard/__init__.py:1164: error: No overload variant of "typechecked"
matches argument types "Union[FunctionType, MethodType, Type[Any]]", "Any",
"Dict[str, Any]"  [call-overload]
                            typechecked(attr, always=always, _localns=func...
                            ^
src/typeguard/__init__.py:1164: note: Possible overload variants:
src/typeguard/__init__.py:1164: note:     def typechecked(*, always: bool = ...) -> Callable[[T_CallableOrType], T_CallableOrType]
src/typeguard/__init__.py:1164: note:     def [T_CallableOrType] typechecked(func: T_CallableOrType, *, always: bool = ...) -> T_CallableOrType
src/typeguard/__init__.py:1168: error: No overload variant of "typechecked"
matches argument types "Callable[..., Any]", "Any", "Dict[str, Any]" 
[call-overload]
                        wrapped = typechecked(attr.__func__, always=always...
                                  ^
src/typeguard/__init__.py:1168: note: Possible overload variants:
src/typeguard/__init__.py:1168: note:     def typechecked(*, always: bool = ...) -> Callable[[T_CallableOrType], T_CallableOrType]
src/typeguard/__init__.py:1168: note:     def [T_CallableOrType] typechecked(func: T_CallableOrType, *, always: bool = ...) -> T_CallableOrType
src/typeguard/__init__.py:1174: error: Argument 3 to "getattr" has incompatible
type "Tuple[]"; expected "bool"  [arg-type]
    ...ty_func is not None and getattr(property_func, "__annotations__", ()):
                                                                         ^
src/typeguard/__init__.py:1175: error: No overload variant of "typechecked"
matches argument types "Any", "Any", "Dict[str, Any]"  [call-overload]
                            kwargs[name] = typechecked(
                                           ^
src/typeguard/__init__.py:1175: note: Possible overload variants:
src/typeguard/__init__.py:1175: note:     def typechecked(*, always: bool = ...) -> Callable[[T_CallableOrType], T_CallableOrType]
src/typeguard/__init__.py:1175: note:     def [T_CallableOrType] typechecked(func: T_CallableOrType, *, always: bool = ...) -> T_CallableOrType
src/typeguard/__init__.py:1179: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any], Any]]"  [arg-type]
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1179: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any, Any], None]]"  [arg-type]
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1179: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any], None]]"  [arg-type]
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1219: error: Returning Any from function declared to
return
"Union[TypeCheckedGenerator, TypeCheckedAsyncGenerator, GeneratorType[Any, Any, Any]]"
 [no-any-return]
            return retval
            ^
Found 10 errors in 1 file (checked 3 source files)

You should broaden the annotations, possibly using Any where the proper type cannot be determined.

agronholm · 2022-03-02T15:10:50Z

There are code styling changes not related to annotations. Please undo those changes.

The GitHub Actions workflow should have a step to run mypy. You should add that.

eggplants · 2022-03-02T16:33:21Z

@agronholm done.

eggplants · 2022-03-02T16:39:00Z

$ git rev-parse HEAD # now
e84ca55ff3d2743a0924e08ad088f7470f3a4745
$ mypy tests/mypy/test_type_annotations.py src
src/typeguard/__init__.py:1030: error: Argument 3 to "getattr" has incompatible
type "Tuple[]"; expected "bool"
    ...ty_func is not None and getattr(property_func, '__annotations__', ()):
                                                                         ^
src/typeguard/__init__.py:1033: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any], Any]]"
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1033: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any, Any], None]]"
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1033: error: Argument 1 to "property" has
incompatible type "**Dict[str, Optional[str]]"; expected
"Optional[Callable[[Any], None]]"
                    setattr(func, key, attr.__class__(**kwargs))
                                                        ^
src/typeguard/__init__.py:1057: error: "None" not callable
            retval = func(*args, **kwargs)
                     ^
src/typeguard/__init__.py:1073: error: Returning Any from function declared to
return
"Union[TypeCheckedGenerator, TypeCheckedAsyncGenerator, GeneratorType[Any, Any, Any]]"
            return retval
            ^
src/typeguard/__init__.py:1078: error: "None" not callable
            retval = await func(*args, **kwargs)
                           ^
Found 7 errors in 1 file (checked 4 source files)

agronholm · 2022-03-02T16:39:51Z

This line runs mypy; it should be modified to check the entire codebase.

eggplants · 2022-03-02T16:40:59Z

This line runs mypy; it should be modified to check the entire codebase.

Please check: e84ca55

agronholm · 2022-03-02T16:43:22Z

Those mypy errors look nonsensical. I wonder if pyright gives similar errors.

error: Argument 3 to "getattr" has incompatible type "Tuple[]"; expected "bool"

agronholm · 2022-03-02T16:45:21Z

This line runs mypy; it should be modified to check the entire codebase.

Please check: e84ca55

Ah, quite right.

src/typeguard/__init__.py:1033: error: Argument 1 to "property" has incompatible type "**Dict[str, Optional[str]]"; expected "Optional[Callable[[Any], Any]]" setattr(func, key, attr.__class__(**kwargs)) ^ src/typeguard/__init__.py:1033: error: Argument 1 to "property" has incompatible type "**Dict[str, Optional[str]]"; expected "Optional[Callable[[Any, Any], None]]" setattr(func, key, attr.__class__(**kwargs)) ^ src/typeguard/__init__.py:1033: error: Argument 1 to "property" has incompatible type "**Dict[str, Optional[str]]"; expected "Optional[Callable[[Any], None]]" setattr(func, key, attr.__class__(**kwargs)) ^ src/typeguard/__init__.py:1057: error: "None" not callable retval = func(*args, **kwargs) ^ src/typeguard/__init__.py:1073: error: Returning Any from function declared to return "Union[TypeCheckedGenerator, TypeCheckedAsyncGenerator, GeneratorType[Any, Any, Any]]" return retval ^ src/typeguard/__init__.py:1078: error: "None" not callable retval = await func(*args, **kwargs)

eggplants · 2022-03-02T16:53:40Z

$ git rev-parse HEAD # now
a9c2fb9c91303e3d75bb121aeba2ae1655e07b99
$ mypy tests/mypy/test_type_annotations.py src
Success: no issues found in 4 source files
$ pytest
============================= test session starts ==============================
platform darwin -- Python 3.9.9, pytest-6.2.5, py-1.11.0, pluggy-1.0.0
rootdir: /Users/eggplants/prog/typeguard, configfile: pyproject.toml, testpaths: tests
plugins: subtests-0.5.0, monkeytype-1.1.0, mock-3.7.0, typeguard-2.13.3, cov-3.0.0
collected 243 items

tests/test_importhook.py .................                               [  6%]
tests/test_typeguard.py ................................................ [ 26%]
........................................................................ [ 56%]
........................................................................ [ 86%]
................                                                         [ 92%]
tests/test_typeguard_py36.py ................                            [ 99%]
tests/mypy/test_type_annotations.py ..                                   [100%]

=============================== warnings summary ===============================
tests/test_typeguard_py36.py::TestTypeChecker::test_callable
  /Users/eggplants/.pyenv/versions/3.9.9/lib/python3.9/site-packages/typeguard/__init__.py:1027: UserWarning: no code associated -- not typechecking test_typeguard_py36.<test_typeguard_py36.TestTypeChecker.test_callable.<locals>.command object at 0x111d40130>
    warn('no code associated -- not typechecking {}'.format(function_name(func)))

-- Docs: https://docs.pytest.org/en/stable/warnings.html
======================== 243 passed, 1 warning in 1.20s ========================

$ grep -r '# type: ignore' src/typeguard/*.py | wc -l
20

20 suppressed errors exist...

src/typeguard/__init__.py:1135:30: E126 continuation line over-indented for hanging indent

agronholm · 2022-03-02T22:05:27Z

I'm sorry I didn't think of this before (I was travelling), but you probably should've based this on the 3.0 branch. I have no intention of updating the 2.x series anymore.

eggplants · 2022-03-02T22:14:03Z

I have not noticed branch 3.0 until now. I'll try to annotate it later.

eggplants · 2022-03-02T22:16:12Z

I'm sorry I didn't think of this before (I was travelling), but you probably should've based this on the 3.0 branch. I have no intention of updating the 2.x series anymore.

Please document in either README or Documentation in your free time.

agronholm · 2022-03-02T22:36:05Z

I expected to release 3.0 much sooner but got sidetracked by other work, leading to this awkward situation.

eggplants · 2022-03-02T22:42:03Z

To avoid confusion for others, till 3.0 is published, I recommend either:

add a single sentence of caution to the README
pin the Issue that describes this information
set the Default branch to 3.0
...

Otherwise, more people's time is bound to be wasted.

eggplants added 4 commits March 2, 2022 09:02

add: black configuration

3edf90d

add: dev dependencies to extra_requires

0b0b8a7

add: target path to mypy configration

80c2d02

add: fill missing type hints, except typechecked

fcbf8e0

rm: useless configuration

4fe2a2c

eggplants added 8 commits March 3, 2022 00:18

revert: blacked quotations

5cb74e2

revert: line-length

c774fb1

revert: line-length

0cfdf5a

revert: style of pytest_plugin.py

0dc6126

revert: style of importhook.py

a18f9b0

revert: style of __init__.py (1/2)

3c4b90e

revert: style of __init__.py (2/2)

2f9367a

fix: returned None explicitly in return statements

02b900c

eggplants added 2 commits March 3, 2022 01:35

fix: syntax error

d12ddcc

fix: mypy command in ci to test src/ with mypy

e84ca55

fix: mypy error

f135c4c

error: Argument 3 to "getattr" has incompatible type "Tuple[]"; expected "bool"

eggplants added 3 commits March 3, 2022 04:08

fix: flake errors

9bba93b

fix: flake8 error

47f25b2

src/typeguard/__init__.py:1135:30: E126 continuation line over-indented for hanging indent

fix: fix positions of type: ignore comments

05c6d1c

eggplants closed this Mar 2, 2022

eggplants deleted the add_type_hint branch March 3, 2022 00:36

eggplants mentioned this pull request Mar 26, 2022

Coding style #244

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fill missing type hints #241

Fill missing type hints #241

eggplants commented Mar 2, 2022 •

edited

eggplants commented Mar 2, 2022 •

edited

agronholm commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022

agronholm commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022

eggplants commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022 •

edited

agronholm commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022 •

edited

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022

eggplants commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022 •

edited

Fill missing type hints #241

Fill missing type hints #241

Conversation

eggplants commented Mar 2, 2022 • edited

eggplants commented Mar 2, 2022 • edited

agronholm commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022

agronholm commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022

eggplants commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022 • edited

agronholm commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022 • edited

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022

eggplants commented Mar 2, 2022

agronholm commented Mar 2, 2022

eggplants commented Mar 2, 2022 • edited

eggplants commented Mar 2, 2022 •

edited

eggplants commented Mar 2, 2022 •

edited

eggplants commented Mar 2, 2022 •

edited

eggplants commented Mar 2, 2022 •

edited

eggplants commented Mar 2, 2022 •

edited