feat: Add type hint comment support #87
Conversation
Fix tox-dev#13 I've made it so that there's as little risk of regression as possible for existing users by shortcutting to `get_type_hints` or `__annotations__` if that approach works. If those return empty mappings, use `typed_ast` with `inspect.getsource` to get type hint comments.
| Class docstring. | ||
|
|
||
| Parameters: | ||
| **x** -- foo |
There was a problem hiding this comment.
I know this looks like any other unresolvable type. I think we could fix that in the least lines of code by setting __annotations__ on the obj, and calling get_type_hints again to resolve the names we extracted from the type hint comments... lmk what you think of this approach
|
Aside from some minor code formatting nits, this looks good to me. Thanks! |
|
@agronholm feel free to point those nits out |
|
Parameters put on too many lines, and backticks used where a double quote would have been preferred by me. Nothing worth fussing about, really. |
|
It would be fantastic if this could be rolled into a PyPI release |
|
I will do that soon once I'm done with the outstanding patches lined up for that release. |
|
This is now in v1.7.0. |
| children = list(ast.iter_child_nodes(module)) | ||
|
|
||
| if len(children) != 1: | ||
| logger.warning( |
There was a problem hiding this comment.
Why this check? This basically disallows doing:
def magic(router, **options):
# type: (str, Any) -> Callable[[Any], Any]
There was a problem hiding this comment.
Is this indentation intended? I ran into this warning a bunch of times but didn't investigate which items produce two ast nodes. I am also not sure what to do with two ast nodes
There was a problem hiding this comment.
just select the first function definition? (type ignore elements should be definitely filtered out) - with the current implementation if the body has type ignores in it this will fail it
There was a problem hiding this comment.
And what about @override?
There was a problem hiding this comment.
can probably come up with something sane 🤔
There was a problem hiding this comment.
As said, this doesn't handle all cases, but bailing out seemed safer than selecting a random node without knowledge of why it yielded multiple.
decorators seemed to work for me, but it would make sense to get multiple nodes for that.
There was a problem hiding this comment.
created https://github.com/agronholm/sphinx-autodoc-typehints/pull/100/files that adds non inlined type comment support 😃
Fix #13
I've made it so that there's as little risk of regression as possible for existing users by shortcutting to
get_type_hintsor__annotations__if that approach works. If those return empty mappings, usetyped_astwithinspect.getsourceto get type hint comments. An additional advantage is thattyped_astis only an optional dependency just for type hint comments.