ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-04-25 02:20:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: updating doc of attributes

Browse Source 
Docs will only be serialized when its different from the
documentation of its type.
This commit is contained in:
Mose Müller 2023-08-09 16:49:14 +02:00
parent d8aa944e6d
commit 4d66b6b27c
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/pydase/data_service/data_service.py
View File

@ -203,6 +203,18 @@ class DataService(rpyc.Service, AbstractDataService):
# Merge the class and instance dictionaries # Merge the class and instance dictionaries
merged_set = derived_only_set | instance_dict merged_set = derived_only_set | instance_dict
def get_attribute_doc(attr: Any) -> Optional[str]:
"""This function takes an input attribute attr and returns its documentation
string if it's different from the documentation of its type, otherwise,
it returns None.
"""
attr_doc = inspect.getdoc(attr)
attr_class_doc = inspect.getdoc(type(attr))
if attr_class_doc != attr_doc:
return attr_doc
else:
return None
# Iterate over attributes, properties, class attributes, and methods # Iterate over attributes, properties, class attributes, and methods
for key in sorted(merged_set): for key in sorted(merged_set):
if key.startswith("_"): if key.startswith("_"):
@ -230,7 +242,7 @@ class DataService(rpyc.Service, AbstractDataService):
else "DataService", else "DataService",
"value": value.serialize(), "value": value.serialize(),
"readonly": False, "readonly": False,
"doc": inspect.getdoc(value), "doc": get_attribute_doc(value),
} }
elif isinstance(value, list): elif isinstance(value, list):
result[key] = { result[key] = {
@ -245,6 +257,7 @@ class DataService(rpyc.Service, AbstractDataService):
if isinstance(item, DataService) if isinstance(item, DataService)
else item, else item,
"readonly": False, "readonly": False,
"doc": get_attribute_doc(value),
} }
for item in value for item in value
], ],
@ -269,7 +282,7 @@ class DataService(rpyc.Service, AbstractDataService):
"type": "method", "type": "method",
"async": asyncio.iscoroutinefunction(value), "async": asyncio.iscoroutinefunction(value),
"parameters": parameters, "parameters": parameters,
"doc": inspect.getdoc(value), "doc": get_attribute_doc(value),
"readonly": True, "readonly": True,
"value": running_task_info, "value": running_task_info,
} }
@ -281,7 +294,7 @@ class DataService(rpyc.Service, AbstractDataService):
if not isinstance(value, u.Quantity) if not isinstance(value, u.Quantity)
else {"magnitude": value.m, "unit": str(value.u)}, else {"magnitude": value.m, "unit": str(value.u)},
"readonly": prop.fset is None, "readonly": prop.fset is None,
"doc": inspect.getdoc(prop), "doc": get_attribute_doc(prop),
} }
elif isinstance(value, Enum): elif isinstance(value, Enum):
result[key] = { result[key] = {
@ -292,6 +305,7 @@ class DataService(rpyc.Service, AbstractDataService):
for name, member in value.__class__.__members__.items() for name, member in value.__class__.__members__.items()
}, },
"readonly": False, "readonly": False,
"doc": get_attribute_doc(value),
} }
else: else:
result[key] = { result[key] = {
@ -300,6 +314,7 @@ class DataService(rpyc.Service, AbstractDataService):
if not isinstance(value, u.Quantity) if not isinstance(value, u.Quantity)
else {"magnitude": value.m, "unit": str(value.u)}, else {"magnitude": value.m, "unit": str(value.u)},
"readonly": False, "readonly": False,
"doc": get_attribute_doc(value),
} }
return result return result