mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-09-23 21:38:51 +00:00
add a note on get_info_2() #4270
This commit is contained in:
@@ -505,6 +505,16 @@ class entity_instance(object):
|
|||||||
__dict__ = property(get_info)
|
__dict__ = property(get_info)
|
||||||
|
|
||||||
def get_info_2(self, include_identifier=True, recursive=False, return_type=dict, ignore=()):
|
def get_info_2(self, include_identifier=True, recursive=False, return_type=dict, ignore=()):
|
||||||
|
"""More perfomant version of `.get_info()` but with limited arguments values.\n
|
||||||
|
Method has exactly the same signature as `.get_info()` but it doesn't support getting information non-recursively.
|
||||||
|
|
||||||
|
Currently supported arguments values:
|
||||||
|
* include_identifier: `True`
|
||||||
|
* recursive: `True` (will fail with default `False` value from `.get_info()`)
|
||||||
|
* return_type: `dict`
|
||||||
|
* ignore: `()` (empty tuple)
|
||||||
|
"""
|
||||||
|
|
||||||
assert include_identifier
|
assert include_identifier
|
||||||
assert recursive
|
assert recursive
|
||||||
assert return_type is dict
|
assert return_type is dict
|
||||||
|
|||||||
Reference in New Issue
Block a user