The api.objects.Stats class¶
Inherits from ABC > SimvueObject
Class for accessing Server statistics.
Methods¶
__init__()¶
Initialise a statistics query object.
commit()¶
Does nothing, no data sendable to server.
count()¶
Return the total number of entries for this object type from the server.
Returns
int
total from server database for current user.
delete()¶
Deletion of stats object is not logical here.
Raises
AttributeError
get()¶
Retrieval of multiple stats object is not logical here.
Raises
AttributeError
id()¶
No unique indentifier for statistics retrieval.
Returns
None
ids()¶
Retrieval of identifiers is not logical here.
Raises
AttributeError
new()¶
Creation of multiple stats objects is not logical here.
Raises
AttributeError
on_reconnect()¶
No offline to online reconnect functionality for statistics.
read_only()¶
Statistics can only be read-only.
Raises
NotImplementedError
refresh()¶
Refresh staging from local data if in read-only mode.
to_dict()¶
Dictionary form of statistics.
Returns
doct[str, Any]
statistics data as dictionary
whoami()¶
Return the current user information.
Returns
dict[str, str]
server response for 'whomai' query.
Properties¶
staged¶
Return currently staged changes to this object.
Returns
dict[str, Any] | None
the locally staged data if available.
url¶
The URL for accessing this object on the server.
Returns
simvue.api.url.URL | None