arkouda.core.infoclass¶

Utilities for introspecting Arkouda server-side objects.

The arkouda.infoclass module provides tools to inspect, query, and display metadata about objects stored in the Arkouda symbol table or registry. These utilities are useful for debugging, exploratory analysis, and monitoring the state of server-managed data.

Constants¶

AllSymbolsstr: Special string flag to query all objects in the symbol table.
RegisteredSymbolsstr: Special string flag to query only registered objects.

Classes¶

InfoEntry: Lightweight container representing object metadata (name, dtype, size, shape, etc.).
EntryDecoder: JSON encoder for serializing InfoEntry objects.

Functions¶

information(names): Return JSON-formatted string describing the server-side objects given by names.
list_registry(detailed=False): Return all registered Arkouda objects, optionally including type information.
list_symbol_table(): Return a list of all object names currently stored in the Arkouda symbol table.
pretty_print_information(names): Print human-readable metadata about objects specified by names.

Notes

The symbol table includes all objects created during a session.
The registry includes only explicitly registered objects (e.g., for persistence or sharing).
information uses generic_msg to request metadata from the Arkouda server.
These functions are useful for interactive sessions, diagnostics, or automated logging.

Examples

>>> import arkouda as ak
>>> x = ak.arange(5)
>>> ak.information(ak.AllSymbols)
'[{"name":"id_i3gP47x_1", "dtype":"int64", "size":5,
"ndim":1, "shape":[5], "itemsize":8, "registered":false}]'
>>> x.register("name1")
array([0 1 2 3 4])
>>> ak.list_registry(detailed=True)
'Objects': [('name1', 'PDARRAY')], 'Components': ['id_beYOiDM_1']}
>>> ak.list_symbol_table()
['id_beYOiDM_1']

Attributes¶

`AllSymbols`
`RegisteredSymbols`

Functions¶

`information`(→ str)	Return a JSON formatted string containing information about the objects in names.
`list_registry`([detailed])	Return a list containing the names of all registered objects.
`list_symbol_table`(→ List[str])	Return a list containing the names of all objects in the symbol table.
`pretty_print_information`(→ None)	Print verbose information for each object in names in a human readable format.

Module Contents¶

arkouda.core.infoclass.AllSymbols = '__AllSymbols__'¶

arkouda.core.infoclass.RegisteredSymbols = '__RegisteredSymbols__'¶

arkouda.core.infoclass.information(names: List[str] | str = RegisteredSymbols) → str[source]¶

Return a JSON formatted string containing information about the objects in names.

Parameters:: names (Union[List[str], str]) – names is either the name of an object or list of names of objects to retrieve info if names is ak.AllSymbols, retrieves info for all symbols in the symbol table if names is ak.RegisteredSymbols, retrieves info for all symbols in the registry
Returns:: JSON formatted string containing a list of information for each object in names
Return type:: str
Raises:: RuntimeError – Raised if a server-side error is thrown in the process of retrieving information about the objects in names

arkouda.core.infoclass.list_registry(detailed: bool = False)[source]¶

Return a list containing the names of all registered objects.

Parameters:: detailed (bool) – Default = False Return details of registry objects. Currently includes object type for any objects
Returns:: Dict containing keys “Components” and “Objects”.
Return type:: dict
Raises:: RuntimeError – Raised if there’s a server-side error thrown

arkouda.core.infoclass.list_symbol_table() → List[str][source]¶

Return a list containing the names of all objects in the symbol table.

Returns:: List of all object names in the symbol table
Return type:: list
Raises:: RuntimeError – Raised if there’s a server-side error thrown

arkouda.core.infoclass.pretty_print_information(names: List[str] | str = RegisteredSymbols) → None[source]¶

Print verbose information for each object in names in a human readable format.

Parameters:: names (Union[List[str], str]) – names is either the name of an object or list of names of objects to retrieve info if names is ak.AllSymbols, retrieves info for all symbols in the symbol table if names is ak.RegisteredSymbols, retrieves info for all symbols in the registry
Raises:: RuntimeError – Raised if a server-side error is thrown in the process of retrieving information about the objects in names