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; None when epoch is None or outside datetime’s range.

synology_apm_repo.sdk.units.provider_kit.mtime_from_raw(raw)

mtime_from_epoch for an untyped Table.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 diagnostic as its user-facing reason.

synology_apm_repo.sdk.units.provider_kit.not_restorable(kind, ref)

Raise the NotRestorableError every UnitProvider.unit implementation raises for a resolved-but-contentless node/item.

Parameters:
  • kind (str) – "node" or "item".

  • ref (object) – That node’s name or that item’s key.

synology_apm_repo.sdk.units.provider_kit.dir_first_sort_key(is_dir, name)

The child-ordering policy every browsable file/folder-tree UnitProvider applies: containers before leaves, then each group alphabetically by name (byte/codepoint comparison, no case folding). Use as a sorted(..., 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 SQL ORDER BY expression. is_dir_sql is a boolean SQL expression true for a container row; order_by is 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 database ORDER 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 when limit is None) — for a provider whose listing is already a small, fully-materialized sequence, rather than pushed down into a real SQL LIMIT/OFFSET.