History
Change tracking helpers from annnet.core._History.
annnet.core._History.GraphDiff
Represents the difference between two graph states.
Attributes:
| Name | Type | Description |
|---|---|---|
vertices_added |
set
|
Vertices in b but not in a |
vertices_removed |
set
|
Vertices in a but not in b |
edges_added |
set
|
Edges in b but not in a |
edges_removed |
set
|
Edges in a but not in b |
slices_added |
set
|
slices in b but not in a |
slices_removed |
set
|
slices in a but not in b |
Functions
summary()
Return a human-readable summary of differences.
Returns:
| Type | Description |
|---|---|
str
|
Summary text describing added/removed vertices, edges, and slices. |
is_empty()
Check whether the diff contains no changes.
Returns:
| Type | Description |
|---|---|
bool
|
|
to_dict()
Convert the diff to a serializable dictionary.
Returns:
| Type | Description |
|---|---|
dict
|
|
annnet.core._History.History
Functions
history(as_df=False)
Return the append-only mutation history.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
as_df
|
bool
|
If True, return a DataFrame; otherwise return a list of dicts. |
False
|
Returns:
| Type | Description |
|---|---|
list[dict] | DataFrame
|
Event records including |
Notes
Ordering is guaranteed by version and mono_ns. The log is in-memory
until exported.
export_history(path)
Write the mutation history to disk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str
|
Output path. Supported extensions: |
required |
Returns:
| Type | Description |
|---|---|
int
|
Number of events written. Returns 0 if the history is empty. |
Raises:
| Type | Description |
|---|---|
OSError
|
If the file cannot be written. |
Notes
Unknown extensions default to Parquet by appending .parquet.
enable_history(flag=True)
Enable or disable in-memory mutation logging.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
flag
|
bool
|
When True, start/continue logging; when False, pause logging. |
True
|
Returns:
| Type | Description |
|---|---|
None
|
|
clear_history()
Clear the in-memory mutation log.
Returns:
| Type | Description |
|---|---|
None
|
|
Notes
This does not delete any files previously exported.
mark(label)
Insert a manual marker into the mutation history.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
label
|
str
|
Human-readable tag for the marker event. |
required |
Returns:
| Type | Description |
|---|---|
None
|
|
Notes
The event is recorded with op='mark' alongside standard fields
(version, ts_utc, mono_ns). Logging must be enabled for the
marker to be recorded.