Skip to content

Commit b87b43e

Browse files
committed
ENH: Introduce Variable.kind: Literal["var","prop"]
1 parent f4251dd commit b87b43e

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
@@ -993,23 +993,13 @@ def definition_order_index(
993993
self.doc[name] = Function(
994994
name, self.module, obj, cls=self)
995995
else:
996-
if isinstance(obj, property):
997-
kind = "property"
998-
if obj.fget is not None:
999-
kind += "/get"
1000-
if obj.fset is not None:
1001-
kind += "/set"
1002-
if obj.fdel is not None:
1003-
kind += "/del"
1004-
else:
1005-
kind = "var"
1006996
self.doc[name] = Variable(
1007997
name, self.module,
1008998
docstring=(
1009999
var_docstrings.get(name) or
10101000
(inspect.isclass(obj) or _is_descriptor(obj)) and inspect.getdoc(obj)),
10111001
cls=self,
1012-
kind=kind,
1002+
kind="prop" if isinstance(obj, property) else "var",
10131003
obj=_is_descriptor(obj) and obj or None,
10141004
instance_var=(_is_descriptor(obj) or
10151005
name in getattr(self.obj, '__slots__', ())))
@@ -1511,8 +1501,8 @@ def __init__(self, name, module, docstring, *,
15111501

15121502
self.kind = kind
15131503
"""
1514-
One of `var`, `property/get/set/del` with one or more of get, set, del,
1515-
e.g. property/get/set for a property that can be read and set.
1504+
`prop` if variable is a dynamic property (has getter/setter or deleter),
1505+
or `var` otherwise.
15161506
"""
15171507

15181508
@property

0 commit comments

Comments
 (0)