chore: Remove 'get_specs' from datamodel help. #4574
Conversation
…github.com/ansys/pyfluent into maint/remove_get_specs_from_datamodel_help
| help_lines.extend( | ||
| [" " + line for line in param._get_help_string().splitlines()] | ||
| ) | ||
| elif isinstance(self, PyParameter): |
There was a problem hiding this comment.
Why not just override it?
| cls_name = self.__class__.__name__ | ||
| is_task_object = cls_name == "_TaskObject" | ||
|
|
||
| if is_task_object: |
There was a problem hiding this comment.
Related to the PyParameter comment below, this should also be handled polymorphically, or at least externally (a type-based strategy).
| name = str(self).split()[0].split(".")[-1] | ||
| default_val = getattr(self, "default_value", None) | ||
| default = default_val() if callable(default_val) else None | ||
| if isinstance(self, PyTextual): |
There was a problem hiding this comment.
Each of these conditions can be handled via an override per type.
| default_val = getattr(self, "default_value", None) | ||
| default = default_val() if callable(default_val) else None |
There was a problem hiding this comment.
I don't get what's going on here. Can we please have some comments?
There was a problem hiding this comment.
ok, sure. If the default value returns something then we add it. Will add some inline comments.
There was a problem hiding this comment.
In this case, "default_val" can either be the attr or None. In the next line, it checks if it is not None then return the value of "default_val". Will simplify the logic as well.
Context
'get_specs' was used for generating the dynamic help.
Change Summary
Dynamic help does not depend on 'get_specs' any longer.
Rationale
Dynamic help is constructed via attribute query as required.
Impact
Mostly no impact on the end users as the help text is expected to remain same.
PyCommand:
PyCommandArguments: