pip_services3_commons.reflect.RecursiveObjectReader module
pip_services3_commons.reflect.RecursiveObjectReader
Recursive object reader implementation
- copyright
Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.
- license
MIT, see LICENSE for more details.
-
class
pip_services3_commons.reflect.RecursiveObjectReader.RecursiveObjectReader Bases:
objectHelper class to perform property introspection and dynamic reading.
It is similar to
ObjectReaderbut reads properties recursively through the entire object graph. Nested property names are defined using dot notation as “object.subobject.property”-
static
get_properties(obj: Any) → Any Get values of all properties in specified object and its subobjects and returns them as a map.
The object can be a user defined object, map or array. Returned properties correspondently are object properties, map key-pairs or array elements with their indexes.
- Parameters
obj – an object to get properties from.
- Returns
a map, containing the names of the object’s properties and their values.
-
static
get_property(obj: Any, name: str) → Any Recursively gets args of object or its subobjects property specified by its name.
The object can be a user defined object, map or array. The property name correspondently must be object property, map key or array index.
- Parameters
obj – an object to read property from.
name – a name of the property to get.
- Returns
the property args or null if property doesn’t exist or introspection failed.
-
static
get_property_names(obj: Any) → List[str] Recursively gets names of all properties implemented in specified object and its subobjects.
The object can be a user defined object, map or array. Returned property name correspondently are object properties, map keys or array indexes.
- Parameters
obj – an object to introspect.
- Returns
a list with property names.
-
static
has_property(obj: Any, name: str) → bool Checks recursively if object or its subobjects has a property with specified name.
The object can be a user defined object, map or array. The property name correspondently must be object property, map key or array index.
- Parameters
obj – an object to introspect.
name – a name of the property to check.
- Returns
true if the object has the property and false if it doesn’t.
-
static