graphrecords.overview#

Overview classes summarizing the contents of a GraphRecord.

Module Attributes

`DEFAULT_TRUNCATE_DETAILS`	The number of details an overview shows before it truncates them.
`AttributeOverviewData`	A type alias for the overview data of an attribute of any type.

Classes

`AttributeOverview`()	Overview data of an attribute.
`CategoricalAttributeOverview`	The overview data of a categorical attribute.
`ContinuousAttributeOverview`	The overview data of a continuous attribute.
`EdgeGroupOverview`()	Overview data of the edges of a group.
`GroupOverview`()	Overview data of the nodes and edges of a group.
`NodeGroupOverview`()	Overview data of the nodes of a group.
`Overview`()	Overview data of every group of a GraphRecord, and of its ungrouped part.
`TemporalAttributeOverview`	The overview data of a temporal attribute.
`UnstructuredAttributeOverview`	The overview data of an unstructured attribute.

class AttributeOverview[source]#

Bases: object

Overview data of an attribute.

__repr__()[source]#

Returns the string representation of the AttributeOverview.

Return type:: str
Returns:: str – The string representation of the AttributeOverview.

property data: CategoricalAttributeOverview | ContinuousAttributeOverview | TemporalAttributeOverview | UnstructuredAttributeOverview#

The overview data of the attribute.

Returns:

AttributeOverviewData –

The overview data, shaped by the statistical type: of the attribute.

property data_type: DataType#

The data type of the attribute.

Returns:: DataType – The data type of the attribute.

AttributeOverviewData#

A type alias for the overview data of an attribute of any type.

alias of CategoricalAttributeOverview | ContinuousAttributeOverview | TemporalAttributeOverview | UnstructuredAttributeOverview

class CategoricalAttributeOverview[source]#

Bases: TypedDict

The overview data of a categorical attribute.

attribute_type: Literal[AttributeType.Categorical]#

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

distinct_values: List[Union[str, int, float, bool, datetime, timedelta, None]]#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from mapping/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

class ContinuousAttributeOverview[source]#

Bases: TypedDict

The overview data of a continuous attribute.

attribute_type: Literal[AttributeType.Continuous]#

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

max: Union[str, int, float, bool, datetime, timedelta, None]#

mean: Union[str, int, float, bool, datetime, timedelta, None]#

min: Union[str, int, float, bool, datetime, timedelta, None]#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from mapping/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

DEFAULT_TRUNCATE_DETAILS: Final[int] = 80#: The number of details an overview shows before it truncates them.

class EdgeGroupOverview[source]#

Bases: object

Overview data of the edges of a group.

__repr__()[source]#

Returns the string representation of the EdgeGroupOverview.

Return type:: str
Returns:: str – The string representation of the EdgeGroupOverview.

property attributes: Dict[str | int, AttributeOverview]#

The attribute overviews of the edges.

Returns:

Dict[AttributeName, AttributeOverview] –

The overview of every edge: attribute.

property count: int#

The number of edges in the group.

Returns:: int – The number of edges in the group.

class GroupOverview[source]#

Bases: object

Overview data of the nodes and edges of a group.

__repr__()[source]#

Returns the string representation of the GroupOverview.

Return type:: str
Returns:: str – The string representation of the GroupOverview.

property edge_overview: EdgeGroupOverview#

The overview of the edges of the group.

Returns:: EdgeGroupOverview – The overview of the edges.

property node_overview: NodeGroupOverview#

The overview of the nodes of the group.

Returns:: NodeGroupOverview – The overview of the nodes.

class NodeGroupOverview[source]#

Bases: object

Overview data of the nodes of a group.

__repr__()[source]#

Returns the string representation of the NodeGroupOverview.

Return type:: str
Returns:: str – The string representation of the NodeGroupOverview.

property attributes: Dict[str | int, AttributeOverview]#

The attribute overviews of the nodes.

Returns:

Dict[AttributeName, AttributeOverview] –

The overview of every node: attribute.

property count: int#

The number of nodes in the group.

Returns:: int – The number of nodes in the group.

class Overview[source]#

Bases: object

Overview data of every group of a GraphRecord, and of its ungrouped part.

__repr__()[source]#

Returns the string representation of the Overview.

Return type:: str
Returns:: str – The string representation of the Overview.

property grouped_overviews: Dict[str | int, GroupOverview]#

The overview of every group.

Returns:: Dict[GroupIndex, GroupOverview] – The overview of every group.

property ungrouped_overview: GroupOverview#

The overview of everything outside a group.

Returns:: GroupOverview – The overview of the ungrouped part.

class TemporalAttributeOverview[source]#

Bases: TypedDict

The overview data of a temporal attribute.

attribute_type: Literal[AttributeType.Temporal]#

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

max: Union[str, int, float, bool, datetime, timedelta, None]#

min: Union[str, int, float, bool, datetime, timedelta, None]#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from mapping/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

class UnstructuredAttributeOverview[source]#

Bases: TypedDict

The overview data of an unstructured attribute.

attribute_type: Literal[AttributeType.Unstructured]#

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

distinct_count: int#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from mapping/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#