tiled.client.array.ArrayClient

class tiled.client.array.ArrayClient(*args, item, **kwargs)

Client-side wrapper around an array-like that returns in-memory arrays

__init__(*args, item, **kwargs)

Methods

__init__(*args, item, **kwargs)
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.
compute()	Alias to client.read().compute()
data_sources()
delete([recursive, external_only])	Delete the node and its contents, if any.
export(filepath, *[, format, slice, link, ...])	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])	Write data into a slice of an array, maybe 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])	Access the entire array or a slice.
read_block(block[, slice])	Access the data for one block of this chunked array.
refresh()
replace_metadata([metadata, specs, ...])	EXPERIMENTAL: Replace metadata entirely (see update_metadata).
structure()	Return a dataclass describing the structure of the data.
subscribe([executor])	Subscribe to streaming updates about this array.
update_metadata([metadata, specs, ...])	EXPERIMENTAL: Update metadata via a dict.update- like interface.
write(array)
write_block(array, block[, slice])

Attributes

URL_CHARACTER_LIMIT
access_blob	Authorization information about this node, in blob form
chunks
context
dims
dtype
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
nbytes
ndim
parent	Returns a client for the parent of this node.
path_parts	Location of node in tree, given as list of path segments.
shape
size
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