tiled.client.base.BaseClient
- class tiled.client.base.BaseClient(context: Context, *, item, structure_clients, structure=None, include_data_sources=False)[source]
- __init__(context: Context, *, item, structure_clients, structure=None, include_data_sources=False)[source]
Methods
__init__
(context, *, item, structure_clients)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.
data_sources
()delete_tree
()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.
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_metadata
([metadata_patch, ...])EXPERIMENTAL: Patch metadata using a JSON Patch (RFC6902).
raw_export
([destination_directory, max_workers])Download the raw assets backing this node.
refresh
()replace_metadata
([metadata, specs, ...])EXPERIMENTAL: Replace metadata entirely (see update_metadata).
Return a dataclass describing the structure of the data.
update_metadata
([metadata, specs, ...])EXPERIMENTAL: Update metadata via a dict.update- like interface.
Attributes
URL_CHARACTER_LIMIT
access_blob
Authorization information about this node, in blob form
context
List formats that the server can export this data as.
JSON payload describing this item.
Metadata about this data source.
metadata_revisions
parent
Returns a client for the parent of this node.
List of specifications describing the structure of the metadata and/or data.
Quick access to this entry
Direct link to this entry