def attach(user_defined_name: str) -> Strings:
"""
class method to return a Strings object attached to the registered name in the arkouda
server which was registered using register()
Parameters
----------
user_defined_name : str
user defined name which the Strings object was registered under
Returns
-------
Strings object
the Strings object registered with user_defined_name in the arkouda server
Raises
------
TypeError
Raised if user_defined_name is not a str
See also
--------
register, unregister
Notes
-----
Registered names/Strings objects in the server are immune to deletion
until they are unregistered.
"""
s = Strings(pdarray.attach(f"{user_defined_name}.offsets"),
pdarray.attach(f"{user_defined_name}.bytes"))
s.name = user_defined_name
return s
def attach(user_defined_name: str) -> Categorical:
"""
Function to return a Categorical object attached to the registered name in the
arkouda server which was registered using register()
Parameters
----------
user_defined_name : str
user defined name which Categorical object was registered under
Returns
-------
Categorical
The Categorical object created by re-attaching to the corresponding server components
Raises
------
TypeError
if user_defined_name is not a string
See Also
--------
register, is_registered, unregister, unregister_categorical_by_name
"""
# Build dict of registered components by invoking their corresponding Class.attach functions
parts = {
"categories": Strings.attach(f"{user_defined_name}.categories"),
"codes": pdarray.attach(f"{user_defined_name}.codes"),
}
# Add optional pieces only if they're contained in the registry
registry = list_registry()
if f"{user_defined_name}.permutation" in registry:
parts["permutation"] = pdarray.attach(
f"{user_defined_name}.permutation")
if f"{user_defined_name}.segments" in registry:
parts["segments"] = pdarray.attach(f"{user_defined_name}.segments")
c = Categorical(None, **parts) # Call constructor with unpacked kwargs
c.name = user_defined_name # Update our name
return c
def attach(user_defined_name: str) -> Strings:
return Strings(pdarray.attach(user_defined_name + '_offsets'),
pdarray.attach(user_defined_name + '_bytes'))
def attach(user_defined_name: str) -> 'SArrays':
return SArrays(pdarray.attach(user_defined_name + '_offsets'),
pdarray.attach(user_defined_name + '_bytes'))
