tiled.adapters.excel.ExcelAdapter¶
- class tiled.adapters.excel.ExcelAdapter(mapping, *, metadata=None, sorting=None, specs=None, references=None, access_policy=None, entries_stale_after=None, metadata_stale_after=None, must_revalidate=True)[source]¶
- __init__(mapping, *, metadata=None, sorting=None, specs=None, references=None, access_policy=None, entries_stale_after=None, metadata_stale_after=None, must_revalidate=True)¶
Create a simple Adapter from any mapping (e.g. dict, OneShotCachedMap).
- Parameters:
- mappingdict-like
- metadatadict, optional
- specsList[str], optional
- sortingList[Tuple[str, int]], optional
- specsList[str], optional
- referencesDict[str, URL], optional
- access_policyAccessPolicy, 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, *[, metadata, sorting, ...])Create a simple Adapter from any mapping (e.g.
from_file
(file, *[, specs, references])Read the sheets in an Excel file.
get
(k[,d])get_distinct
(metadata, structure_families, ...)items
()keys
()new_variation
(*args[, mapping, metadata, ...])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.
sort
(sorting)values
()Attributes
background_tasks
entries_stale_after
include_routers
metadata_stale_after
specs
references
access_policy
entries_stale_at
items_indexer
keys_indexer
metadata
Metadata about this Adapter.
metadata_stale_at
must_revalidate
query_registry
sorting
structure_family
values_indexer