tiled.adapters.files.DirectoryAdapter

class tiled.adapters.files.DirectoryAdapter(mapping, directory, index, subdirectory_trie, subdirectory_handler, watcher_thread_kill_switch, manual_trigger, metadata, sorting, access_policy, principal, entries_stale_after=None, metadata_stale_after=None, must_revalidate=True)[source]

An Adapter constructed by walking a directory and watching it for changes.

Examples

>>> DirecotryAdapter.from_directory("path/to/directory")
__init__(mapping, directory, index, subdirectory_trie, subdirectory_handler, watcher_thread_kill_switch, manual_trigger, metadata, sorting, access_policy, principal, entries_stale_after=None, metadata_stale_after=None, must_revalidate=True)[source]

Create a simple Adapter from any mapping (e.g. dict, OneShotCachedMap).

Parameters
mappingdict-like
metadatadict, optional
sortingList[Tuple[str, int]], optional
access_policyAccessPolicy, optional
principalstr, optional
entries_stale_after: timedelta

This server uses this to communite to the client how long it should rely on a local cache before checking back for changes.

metadata_stale_after: timedelta

This server uses this to communite to the client how long it should rely on a local cache before checking back for changes.

must_revalidatebool

Whether the client should strictly refresh stale cache items.

Methods

__init__(mapping, directory, index, ...[, ...])

Create a simple Adapter from any mapping (e.g.

authenticated_as(principal)

from_directory(directory, *[, ...])

Construct a Adapter from a directory of files.

get(k[,d])

items()

keys()

new_variation(*args, **kwargs)

read([fields])

register_query(class_, translator)

register_query_lazy(toplevel, register)

Register a registration function which will be called if the toplevel module (e.g.

search(query)

Return a Adapter with a subset of the mapping.

shutdown_watcher()

sort(sorting)

update_now()

Force an update and block until it completes.

values()

Attributes

DEFAULT_MIMETYPES_BY_FILE_EXT

DEFAULT_READERS_BY_MIMETYPE

access_policy

background_tasks

directory

entries_stale_after

entries_stale_at

include_routers

items_indexer

keys_indexer

metadata

Metadata about this Adapter.

metadata_stale_after

metadata_stale_at

must_revalidate

principal

query_registry

sorting

structure_family

values_indexer