IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

shrink whitelist for `sphinx.ext.autodoc.type_comment` (#11400)

Browse Source 
Co-authored-by: daniel.eades <daniel.eades@hotmail.com>
This commit is contained in:
danieleades 2023-07-23 17:49:18 +01:00 committed by GitHub
parent f06ef37017
commit edd9ea0a39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
pyproject.toml
View File

@ -324,7 +324,6 @@ module = [
"sphinx.ext.autodoc.mock", "sphinx.ext.autodoc.mock",
"sphinx.ext.autodoc.importer", "sphinx.ext.autodoc.importer",
"sphinx.ext.autodoc.preserve_defaults", "sphinx.ext.autodoc.preserve_defaults",
"sphinx.ext.autodoc.type_comment",
"sphinx.ext.autosummary", "sphinx.ext.autosummary",
"sphinx.ext.autosummary.generate", "sphinx.ext.autosummary.generate",
"sphinx.ext.doctest", "sphinx.ext.doctest",

13
sphinx/ext/autodoc/type_comment.py
View File

@ -88,14 +88,19 @@ def get_type_comment(obj: Any, bound_method: bool = False) -> Signature | None:
# subject is placed inside class or block. To read its docstring, # subject is placed inside class or block. To read its docstring,
# this adds if-block before the declaration. # this adds if-block before the declaration.
module = ast.parse('if True:\n' + source, type_comments=True) module = ast.parse('if True:\n' + source, type_comments=True)
subject = cast(ast.FunctionDef, module.body[0].body[0]) # type: ignore subject = cast(
ast.FunctionDef, module.body[0].body[0], # type: ignore[attr-defined]
)
else: else:
module = ast.parse(source, type_comments=True) module = ast.parse(source, type_comments=True)
subject = cast(ast.FunctionDef, module.body[0]) subject = cast(ast.FunctionDef, module.body[0])
if getattr(subject, "type_comment", None): type_comment = getattr(subject, "type_comment", None)
function = ast.parse(subject.type_comment, mode='func_type', type_comments=True) if type_comment:
return signature_from_ast(subject, bound_method, function) # type: ignore function = ast.parse(type_comment, mode='func_type', type_comments=True)
return signature_from_ast(
subject, bound_method, function, # type: ignore[arg-type]
)
else: else:
return None return None
except (OSError, TypeError): # failed to load source code except (OSError, TypeError): # failed to load source code