synology_apm_repo.sdk.units.provider_kit module¶
Helpers every UnitProvider implementation builds its nodes with:
catalog-time conversion, diagnostic placeholders, the “not restorable”
error, the dir-first child order and offset/limit pagination.
- synology_apm_repo.sdk.units.provider_kit.mtime_from_epoch(epoch)¶
A provider’s raw epoch-seconds catalog value as a
Node.mtime;NonewhenepochisNoneor outsidedatetime’s range.
- synology_apm_repo.sdk.units.provider_kit.mtime_from_raw(raw)¶
mtime_from_epochfor an untypedTable.select()row value.
- synology_apm_repo.sdk.units.provider_kit.diagnostic_node(ref, name, diagnostic, handle=None)¶
One synthetic listing node standing in for a provider’s own degrade-instead-of-fail case, with
diagnosticas its user-facing reason.
- synology_apm_repo.sdk.units.provider_kit.not_restorable(kind, ref)¶
Raise the
NotRestorableErroreveryUnitProvider.unitimplementation raises for a resolved-but-contentless node/item.
- synology_apm_repo.sdk.units.provider_kit.dir_first_sort_key(is_dir, name)¶
The child-ordering policy every browsable file/folder-tree
UnitProviderapplies: containers before leaves, then each group alphabetically by name (byte/codepoint comparison, no case folding). Use as asorted(..., key=...)key for a provider that sorts in Python.
- synology_apm_repo.sdk.units.provider_kit.dir_first_order_by(is_dir_sql, order_by)¶
The same containers-before-leaves-then-name policy as
dir_first_sort_key, expressed as a SQLORDER BYexpression.is_dir_sqlis a boolean SQL expression true for a container row;order_byis the already-built name(+tiebreaker) clause ranking rows within each group.
- synology_apm_repo.sdk.units.provider_kit.disk_fs_containers_before_leaves(nodes)¶
Stable-partitions an already-ordered node list into containers (
is_leaf=False) before leaves, each group keeping its incoming relative order — for a disk-image node interleaved with its “(filesystem)” sibling, whose meaningful order (a disk index, a databaseORDER BY)dir_first_sort_key’s alphabetical key would undo.
- synology_apm_repo.sdk.units.provider_kit.paginate(items, offset, limit)¶
Slice
items[offset:offset+limit](open-ended whenlimitisNone) — for a provider whose listing is already a small, fully-materialized sequence, rather than pushed down into a real SQLLIMIT/OFFSET.