Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Add support for type annotations #601

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 76 additions & 1 deletion numpydoc/docscrape.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from collections import namedtuple
from collections.abc import Callable, Mapping
from functools import cached_property
from typing import get_type_hints
from warnings import warn


Expand Down Expand Up @@ -237,7 +238,8 @@ def _parse_param_list(self, content, single_element_is_type=False):
if single_element_is_type:
arg_name, arg_type = "", header
else:
arg_name, arg_type = header, ""
arg_name = header
arg_type = self._get_type_from_signature(header)

desc = r.read_to_next_unindented_line()
desc = dedent_lines(desc)
Expand All @@ -247,6 +249,9 @@ def _parse_param_list(self, content, single_element_is_type=False):

return params

def _get_type_from_signature(self, arg_name: str) -> str:
return ""

# See also supports the following formats.
#
# <FUNCNAME>
Expand Down Expand Up @@ -577,6 +582,11 @@ def dedent_lines(lines):
class FunctionDoc(NumpyDocString):
def __init__(self, func, role="func", doc=None, config=None):
self._f = func
try:
self._signature = inspect.signature(func)
except ValueError:
self._signature = None

self._role = role # e.g. "func" or "meth"

if doc is None:
Expand Down Expand Up @@ -610,6 +620,17 @@ def __str__(self):
out += super().__str__(func_role=self._role)
return out

def _get_type_from_signature(self, arg_name: str) -> str:
if self._signature is None:
return ""

parameter = self._signature.parameters[arg_name.replace("*", "")]

if parameter.annotation == parameter.empty:
return ""
else:
return str(parameter.annotation)


class ObjDoc(NumpyDocString):
def __init__(self, obj, doc=None, config=None):
Expand Down Expand Up @@ -645,6 +666,14 @@ def __init__(self, cls, doc=None, modulename="", func_doc=FunctionDoc, config=No
raise ValueError("No class or documentation string given")
doc = pydoc.getdoc(cls)

if cls is not None:
try:
self._signature = inspect.signature(cls.__init__)
except ValueError:
self._signature = None
else:
self._signature = None

NumpyDocString.__init__(self, doc)

_members = config.get("members", [])
Expand Down Expand Up @@ -728,6 +757,52 @@ def _is_show_member(self, name):
or name in self._cls.__dict__
)

def _get_type_from_signature(self, arg_name: str) -> str:
if self._signature is None:
return ""

arg_name = arg_name.replace("*", "")
try:
parameter = self._signature.parameters[arg_name]
except KeyError:
return self._find_type_hint(self._cls, arg_name)

if parameter.annotation == parameter.empty:
return ""
else:
return str(parameter.annotation)

@staticmethod
def _find_type_hint(cls: type, arg_name: str) -> str:
type_hints = get_type_hints(cls)
try:
annotation = type_hints[arg_name]
except KeyError:
try:
attr = getattr(cls, arg_name)
except AttributeError:
return ""

attr = attr.fget if isinstance(attr, property) else attr

if callable(attr):
try:
signature = inspect.signature(attr)
except ValueError:
return ""

if signature.return_annotation == signature.empty:
return ""
else:
return str(signature.return_annotation)
else:
return type(attr).__name__

try:
return str(annotation.__name__)
except AttributeError:
return str(annotation)


def get_doc_object(
obj,
Expand Down