tiled.client.from_client¶
- tiled.client.from_client(client, structure_clients='numpy', *, username=None, cache=None, offline=False, path=None, special_clients=None, token_cache='/home/runner/.config/tiled/tokens', authentication_uri=None)[source]¶
Advanced: Connect to a Node using a custom instance of httpx.Client or httpx.AsyncClient.
- Parameters
- clienthttpx.Client
Should be pre-configured with a base_url and any auth-related headers.
- structure_clientsstr or dict, optional
Use “dask” for delayed data loading and “numpy” for immediate in-memory structures (e.g. normal numpy arrays, pandas DataFrames). For advanced use, provide dict mapping structure_family names (“array”, “dataframe”, “variable”, “data_array”, “dataset”) to client objects. See
Node.DEFAULT_STRUCTURE_CLIENT_DISPATCH
.- usernamestr, optional
Username for authenticated access.
- cacheCache, optional
- offlinebool, optional
False by default. If True, rely on cache only.
- special_clientsdict, optional
Advanced: Map spec from the server to special client tree objects. See also
Node.discover_special_clients()
andNode.DEFAULT_SPECIAL_CLIENT_DISPATCH
.- token_cachestr, optional
Path to directory for storing refresh tokens.
- authentication_uristr, optional
URL of authentication server