tiled.client.ragged.RaggedClient#

class tiled.client.ragged.RaggedClient(context: Context, *, item, structure_clients, structure=None, include_data_sources=False)[source]#

__init__(context: Context, *, item, structure_clients, structure=None, include_data_sources=False)#

Methods

`__dask_tokenize__`()
`__delattr__`(name, /)	Implement delattr(self, name).
`__dir__`(/)	Default dir() implementation.
`__eq__`(value, /)	Return self==value.
`__format__`(format_spec, /)	Default object formatter.
`__ge__`(value, /)	Return self>=value.
`__getattribute__`(name, /)	Return getattr(self, name).
`__getitem__`(_slice)	Access the array with slicing logic.
`__getstate__`(/)	Helper for pickle.
`__gt__`(value, /)	Return self>value.
`__hash__`(/)	Return hash(self).
`__init__`(context, *, item, structure_clients)
`__init_subclass__`	This method is called when a class is subclassed.
`__le__`(value, /)	Return self<=value.
`__lt__`(value, /)	Return self<value.
`__ne__`(value, /)	Return self!=value.
`__new__`(args, *kwargs)
`__reduce__`(/)	Helper for pickle.
`__reduce_ex__`(protocol, /)	Helper for pickle.
`__repr__`()	Return a brief representation of the ragged data accessible to the `RaggedClient`.
`__setattr__`(name, value, /)	Implement setattr(self, name, value).
`__sizeof__`(/)	Size of object in memory, in bytes.
`__str__`(/)	Return str(self).
`__subclasshook__`	Abstract classes can override this to customize issubclass().
`_build_json_patch`(origin, update_patch)	Lower level method to construct a JSON patch from an origin and update_patch.
`_build_metadata_revisions`()
`asset_manifest`(data_sources)	Return a manifest of the relative paths of the contents in each asset.
`build_metadata_patches`([metadata, specs, ...])	Build valid JSON Patches (RFC6902) for metadata and metadata validation specs accepted by patch_metadata.
`close_stream`()	Declare the end of a stream of writes to this node.
`data_sources`()
`delete`([recursive, external_only])	Delete the node and its contents, if any.
`export`(filepath, *[, slice, format])	Download data in some format and write to a file.
`include_data_sources`()	Ensure that data source and asset information is fetched.
`login`()	Depending on the server's authentication method, this will prompt for username/password:
`logout`()	Log out.
`metadata_copy`()	Generate a mutable copy of metadata, specs, and access_tags for validating metadata (useful with update_metadata())
`new_variation`([structure_clients, ...])	This is intended primarily for internal use and use by subclasses.
`patch`(array, offset[, extend, persist])	Write data into a slice of an array, possibly extending the shape.
`patch_metadata`([metadata_patch, ...])	EXPERIMENTAL: Patch metadata using a JSON Patch (RFC6902).
`raw_export`([destination_directory, max_workers])	Download the raw assets backing this node.
`read`([slice])	Read the entire array, or optionally a slice of it.
`refresh`()
`replace_metadata`([metadata, specs, ...])	EXPERIMENTAL: Replace metadata entirely (see update_metadata).
`structure`()	Return a dataclass describing the structure of the data.
`update_metadata`([metadata, specs, ...])	EXPERIMENTAL: Update metadata via a dict.update- like interface.
`write`(array[, persist])	Write a ragged array in full.
`write_block`(array, block[, persist])	Write a block of ragged array data.

Attributes

`URL_CHARACTER_LIMIT`
`__annotations__`
`__dict__`
`__doc__`
`__module__`
`__weakref__`	list of weak references to the object
`access_blob`	Authorization information about this node, in blob form
`chunked`	Whether the array is chunked along any dimension.
`chunks`	The dask-like chunks of the array, where the first dimension is always partitioned into known integer chunks, and any variable dimensions are None.
`context`
`dims`	The dimension names of the array, if set.
`dtype`	The data type of the array.
`formats`	List formats that the server can export this data as.
`item`	JSON payload describing this item.
`metadata`	Metadata about this data source.
`metadata_revisions`
`ndim`	The dimensionality of the array.
`parent`	Returns a client for the parent of this node.
`path_parts`	Location of node in tree, given as list of path segments.
`shape`	The shape of the array, where unknown variable dimensions are given as `None`.
`size`	The total number of elements in the array.
`specs`	List of specifications describing the structure of the metadata and/or data.
`structure_family`	Quick access to this entry
`uri`	Direct link to this entry