pip_services3_commons.reflect.RecursiveObjectWriter module

pip_services3_commons.reflect.RecursiveObjectWriter.py

Recursive object writer 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.RecursiveObjectWriter.RecursiveObjectWriter

Bases: object

Helper class to perform property introspection and dynamic writing.

It is similar to ObjectWriter but writes properties recursively through the entire object graph. Nested property names are defined using dot notation as “object.subobject.property”

static copy_properties(dest: Any, src: Any)

Copies content of one object to another object by recursively reading all properties from source object and then recursively writing them to destination object.

Parameters

  • dest – a destination object to write properties to.

  • src – a source object to read properties from

static set_properties(obj: Any, values: Any)

Recursively sets values of some (all) object and its subobjects properties.

The object can be a user defined object, map or array. Property values correspondently are object properties, map key-pairs or array elements with their indexes.

If some properties do not exist or introspection fails they are just silently skipped and no errors thrown.

Parameters

  • obj – an object to write properties to.

  • values – a map, containing property names and their values.

static set_property(obj: Any, name: str, value: Any)

Recursively sets args of object and 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.

If the property does not exist or introspection fails this method doesn’t do anything and doesn’t any throw errors.

Parameters

  • obj – an object to write property to.

  • name – a name of the property to set.

  • value – a new args for the property to set.