Skip to content

Commit 5edb408

Browse files
committed
ENH: Introduce Variable.kind: Literal["var","prop"]
1 parent 3c0d5aa commit 5edb408

File tree

1 file changed

+3
-13
lines changed

1 file changed

+3
-13
lines changed

pdoc/__init__.py

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1081,23 +1081,13 @@ def definition_order_index(
10811081
self.doc[name] = Function(
10821082
name, self.module, obj, cls=self)
10831083
else:
1084-
if isinstance(obj, property):
1085-
kind = "property"
1086-
if obj.fget is not None:
1087-
kind += "/get"
1088-
if obj.fset is not None:
1089-
kind += "/set"
1090-
if obj.fdel is not None:
1091-
kind += "/del"
1092-
else:
1093-
kind = "var"
10941084
self.doc[name] = Variable(
10951085
name, self.module,
10961086
docstring=(
10971087
var_docstrings.get(name) or
10981088
(inspect.isclass(obj) or _is_descriptor(obj)) and inspect.getdoc(obj)),
10991089
cls=self,
1100-
kind=kind,
1090+
kind="prop" if isinstance(obj, property) else "var",
11011091
obj=_is_descriptor(obj) and obj or None,
11021092
instance_var=(_is_descriptor(obj) or
11031093
name in getattr(self.obj, '__slots__', ())))
@@ -1638,8 +1628,8 @@ def __init__(self, name: str, module: Module, docstring, *,
16381628

16391629
self.kind = kind
16401630
"""
1641-
One of `var`, `property/get/set/del` with one or more of get, set, del,
1642-
e.g. property/get/set for a property that can be read and set.
1631+
`prop` if variable is a dynamic property (has getter/setter or deleter),
1632+
or `var` otherwise.
16431633
"""
16441634

16451635
@property

0 commit comments

Comments
 (0)