arkouda.infoclass

Module Contents

Functions

information(→ str)	Returns 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)	Prints verbose information for each object in names in a human readable format

Attributes

AllSymbols
RegisteredSymbols

arkouda.infoclass.AllSymbols = '__AllSymbols__'

arkouda.infoclass.RegisteredSymbols = '__RegisteredSymbols__'

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

Returns 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.infoclass.list_registry(detailed: bool = False)

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.infoclass.list_symbol_table() → List[str]

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

Parameters:

None

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.infoclass.pretty_print_information(names: List[str] | str = RegisteredSymbols) → None

Prints 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

Return type:

None

Raises:

RuntimeError – Raised if a server-side error is thrown in the process of retrieving information about the objects in names