Fix/enhance stubgen docstrings for functions, properties and types #16134
Conversation
mypy/stubgenc.py
Outdated
| if is_static_property(obj): | ||
| trailing_comment = " # read-only" if readonly else "" | ||
| static_properties.append(f"{name}: ClassVar[{inferred}] = ...{trailing_comment}") | ||
| if include_docstrings and docstr: | ||
| static_properties.extend(f"{docstr}".split("\n")) |
There was a problem hiding this comment.
Oh, my mistake. I will replace unnecessary formats.
mypy/stubgenc.py
Outdated
| else: # regular property | ||
| if readonly: | ||
| ro_properties.append("@property") | ||
| ro_properties.append(f"def {name}(self) -> {inferred}: ...") | ||
| if include_docstrings and docstr: | ||
| ro_properties.extend(f" {docstr}".split("\n")) |
There was a problem hiding this comment.
Did you mean to indent after splitting?
There was a problem hiding this comment.
Yes, right.
def my_func(self):
'''docstrings here'''
This comment has been minimized.
This comment has been minimized.
lmbelo
force-pushed
the
master
branch
2 times, most recently
from
9a18856 to
07df68d
Compare
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
|
Any chance this can get merged in? I'd really like to test it out. |
There was a problem hiding this comment.
Can you put in a guard against non-str docstrings? I know it shouldn't happen but it's possible at runtime, and I'd rather not have stubgen crash on any code.
>>> def f(): pass
...
>>> f.__doc__ = 42
>>> f.__doc__
42
No need to handle them specially, just ignore all docstrings that aren't instances of str.
Yes, sure. I Will do. |
Fixes #16114
Outputs docstrings for function, properties and types provided by extension modules to the stub file using stubgen.
Note: functions with overloaded signatures are not stripped.