ObjectPath Class

Helper methods for working with json objects.

Constructor

ObjectPath()

assign	Creates a new object by overlaying values in start_object with non-null values from overlay_object.
for_each_property
get_path_value	Get the value for a path relative to an object.
has_value	Does an object have a subpath.
is_int
remove_path_value	Remove path from object.
set_path_value	Given an object evaluate a path to set the value.
try_get_path_value	Get the value for a path relative to an object.
try_resolve_path

Creates a new object by overlaying values in start_object with non-null values from overlay_object.

static assign(start_object, overlay_object, default: Callable | object = None)

Name	Description
start_object Required	dict or typed object, the target object to set values on
overlay_object Required	dict or typed object, the item to overlay values form
default	Provides a default object if both source and overlay are None Default value: None

Type	Description
	A copy of start_object, with values from overlay_object

static for_each_property(obj: object, action: Callable[[str, object], None])

Name	Description
obj Required
action Required

Get the value for a path relative to an object.

static get_path_value(obj, path: str, default: Callable | object = None) -> object

Does an object have a subpath.

static has_value(obj, path: str) -> bool

Name	Description
obj Required
path Required

static is_int(value: str) -> bool

Name	Description
value Required

Remove path from object.

static remove_path_value(obj, path: str)

Name	Description
obj Required
path Required

Given an object evaluate a path to set the value.

static set_path_value(obj, path: str, value: object)

Get the value for a path relative to an object.

static try_get_path_value(obj, path: str) -> object

Name	Description
obj Required
path Required

static try_resolve_path(obj, property_path: str, evaluate: bool = False) -> []

Was this page helpful?