| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
All checks were successful
CultMesh portability and performance / ubuntu-latest reactive semantics and leases (pull_request) Successful in 24m50s
Soul pass on #179: a v3 source converted to v1 (now carried, pinned by the v3-base vector and mutation-checked); README states the one-digit JSON exception once and the object-slot byte difference from C#; CHANGELOG records the entry-type codec inheritance, the doubled walk and the accepted JSON depth refusal; the store-reader docstring and test name no longer overstate 'codec alone'; stale payload_decoder/_refuse_past_depth_limit references fixed. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> |
||
| .. | ||
| src/cultcache_py | ||
| tests | ||
| CHANGELOG.md | ||
| pyproject.toml | ||
| README.md | ||
cultcache-py
cultcache-py is the Python CultCache runtime. Callers work with registered
domain documents while the cache owns schema identity, routing, globals, name
lookups, indexes, and backing-store envelopes.
It is intentionally small. It is not an ORM, a database, or distributed consensus wearing rented authority.
It is the bottom of the Python CultLib stack and depends only on msgpack.
cultnet-py (transport and wire contracts) and cultmesh-py (nodes,
discovery, sessions, local server) build on it, mirroring cultcache-rs /
cultnet-rs / cultmesh-rs and the npm packages.
Current Shape
- document types are registered explicitly
- a registered cache can be used in memory without attaching a backing store
SingleFileMessagePackBackingStorewritescultcache.store.v1snapshots:[format, schemaCatalog, records]- records store raw MessagePack payload bytes under schema-catalog identity
- payloads decode only through the registered document definition for that type
- a payload is exactly one MessagePack value: bytes after it are refused on read, by count
- a cache holds one record per key whatever its type: a write of a second type at a held key is refused with
SchemaConflictError(in memory too), and two stores holding one key refuse the load - a store record no registered type claims loads and is carried as foreign:
cache.foreign_records()lists it, the store keeps its bytes through every write, a write or removal at its key is refused, and registering a type that declares its schema id claims it at the next load - global documents are singleton-style per type
- one home store per document type: a store added with
add_backing_storeowns its types, otherwise the generic store is the home; a type claimed by a second store, or a second generic store, raisesCultCacheError; a write touches exactly one store and nothing is mirrored; once any store is attached, a write whose type has no home raises define_document_type(...)payloads are MessagePack by default;JSON_PAYLOAD_CODECreads stores written by 0.3 and earlierdefine_database_entry_type(...)emits Rust/C#-style slot-indexed MessagePack array payloads for cross-runtimeDatabaseEntrycontracts
Example
from dataclasses import dataclass, asdict
from cultcache_py import CultCache, define_document_type
@dataclass
class Settings:
theme: str
retries: int
settings_doc = define_document_type(
"settings",
encode=lambda value: asdict(value),
decode=lambda payload: Settings(**payload),
global_document=True,
)
cache = (
CultCache.builder()
.register_document_type(settings_doc)
.build()
)
cache.put_global(settings_doc, Settings(theme="ash", retries=3))
settings = cache.get_required_global(settings_doc)
Add JsonLinesBackingStore or SingleFileMessagePackBackingStore when the
cache should persist state; local in-memory cache reads and writes do not need a
store.
Public Surface
define_document_type(...)define_database_entry_type(...)database_entry_field(...)leaves(typed slot leaves)define_document_registry(...)CultCache.builder()register_document_type(...)register_registry(...)register_name_lookup(...)register_index(...)(a unique index)add_backing_store(...)add_generic_store(...)pull_all_backing_stores()get(...)get_required(...)get_all(...)get_key_by_name(...)get_by_name(...)get_key_by_index(...)get_by_index(...)get_global(...)get_required_global(...)put(...)put_envelopes(...)put_global(...)update(document, key, apply, *, max_attempts=5)andupdate_global(document, apply, *, max_attempts=5): the conditional golden path; reads the record as its home store holds it now, runsapplyon a fresh copy, writes only if the record is unchanged and runsapplyagain on a lost race; returnsUpdateResult(outcome, document)withUpdateOutcome.UPDATED,DECLINED(applyreturnedNone) orLOST_RACE(see below)delete(...)delete_global(...)is_writable(document, key)(advisory: would a write or removal of the key be refused; see below)snapshot()
Indexes And Roles
indexes= are unique lookups (variants:ruling:unique-indexes; C# [CultIndex]): within one document type and one alias
no two records hold one non-blank value, judged on the result of every write (a batch is judged whole, so a swap inside
one put_envelopes lands) and of every load and register_index. A refusal is a CultCacheError,
Records <k1> and <k2> (<schema name>) both hold unique index '<alias>'; an index value names one record., keys in
ordinal order, never the value; it writes nothing, and a refused load or registration installs nothing. The contract is
the verdict; the text is informational. Blank values (absent, empty, or only C# White_Space characters) are never
indexed and never conflict. Two types may share an alias and a value. Values compare as the C# canonical text: strings as
is (never trimmed), True/False, integers as digits, a non-integral float as its exact decimal expansion, NaN and
infinities no value.
roles= name selection aliases (C# [CultRole]): many records may share a value, nothing is indexed or refused,
get_by_index on a role answers None, and the member's catalog index_alias is the same either way, so catalog bytes
do not move. An alias is declared in one of the two. CultMeshDatabase.watch_by_index reads indexes only.
Migrating an existing indexes key, per key, before bumping:
- Nothing looks records up by the key (
get_by_index,get_key_by_index,node.get_by_index,watch_by_index): move it toroles. - Something looks it up: it stays unique only when two live records can never hold one non-blank value (the record key
is derived from that value alone, or it is an outside identity: email, sku, external id). Enums, statuses, kinds,
categories, parent or foreign ids, shared hashes and timestamps are roles; select them with
get_allplus a filter. - Open each real
.cconce with the new definitions. A refusal names both keys and the alias and writes nothing.
Misclassifying: a role declared unique makes a store that holds a shared value refuse to open until the key is reclassified; a unique key declared a role answers no lookups and stops refusing duplicates.
Persistence Model
Backing stores persist envelopes, not caller domain objects. The cache decodes payloads through registered document definitions and rejects unknown type discriminators. This keeps Python's dynamic runtime from turning persistence into an open polymorphic sewer with a cheerful docstring.
JsonLinesBackingStore is the control-plane store. It rewrites an atomic JSONL snapshot and base64-encodes the payload bytes its definition's codec wrote. It is designed for compact state spines, settings, ledgers, and bootstrap surfaces.
SingleFileMessagePackBackingStore follows the shared CultCache v1 store shape
used by the TypeScript, Rust, and C# runtimes:
- top-level MessagePack value:
[format, schemaCatalog, records] format:cultcache.store.v1- catalog entries:
[schemaId, schemaName, schemaVersion, contentHash, canonicalSchemaJson, compatibleSchemaIds, members] - records:
[key, schemaId, storedAt, payload]
update needs a home store with the optional read(key) (the record at the key, of any type, and its content version, from one read) and commit_if(envelope, expected) (write only if the record at the key is still that version, under the store's write lock). The content version is the lowercase hex SHA-256 of the record re-encoded as the store writes it, [key, schemaId, storedAt, payload] with minimal MessagePack encodings, the same value C# computes (tests/vectors/content-version). It equals the SHA-256 of the record's bytes in the file exactly when the writer encoded the record minimally, as every writer in this library does; a record encoded with a wider-than-needed length or integer has the version of its minimal form. The single-file store has both; JsonLinesBackingStore and a store without them refuse update before apply runs. A cache with no store copies its held instance. Every write that replaces a record is stored at a later stored_at than the one it replaces, in each store kind and in a store-less cache; push and push_all return the stamp written, and the cache holds that stamp.
Large corpora should use a sharded store or a real database. A single snapshot file is a scalpel, not a forklift.
Store format and rollback
A store whose elements hold an id is marked cultcache.store.v3 by the C# runtime. This runtime reads and writes a v3 single-file store, keeps the header it read and carries the ids through a rewrite; it never drops the mark, so it has no carry-back. A cultcache-py from before element ids refuses a v3 store by name, so rolling back to it after a store has been written as v3 is one-way: restore from a copy taken before upgrading, and upgrade every reader before any writer. (The C# line is different: CultLib 1.x does not refuse; see the GameCult.Caching README.)
Payload format
A definition's payload_codec owns its payload bytes. The default,
MESSAGEPACK_PAYLOAD_CODEC, writes MessagePack; a store holds no format marker,
so the registered definition decides how every record is read. A record in another
format is refused when it is not one value of the definition's codec: a JSON object,
list, string, true or null read as MessagePack is refused by count (<type> payload has N bytes after its first MessagePack value, a ValueError), and a payload
the codec cannot read or carry is a CultCachePayloadFormatError or
CultCachePayloadDepthError. The one exception is a JSON document that is a single
digit (0 to 9), below.
- Map keys are
str, integer, float,boolormsgpack.Timestamp, as the C# reference's object reader takes them;None,bytes, list and map keys are refused, on read and on write. Two keys Python holds as one are refused on read asduplicate_map_key, which includes1beside1.0orTrue: the reference keeps those apart and a Pythondictcannot. The same keys are refused on write asduplicate_map_key, which includes aFloat32key beside an equal int, bool or float key, and two NaN keys, which are one key: the codec never writes bytes its own reader refuses. One pair of keys is the exception to the reference, see Wire Parity. - Arrays and maps nest at most 256 deep (
MAX_PAYLOAD_DEPTH), on read and on write, in the codec and in the definition alike. - Integers beyond 64 bits (outside
-(2**63)..2**64-1) are refused on write asinteger_out_of_range; MessagePack has no wider integer. - Timestamps lie within years 1 to 9999 (
.NETDateTime), and no extension type but the timestamp exists: amsgpack.ExtTypevalue or a timestamp outside that range is refused on read and on write asvalue_kindortimestamp_out_of_range. - A store written by cultcache-py 0.3 or earlier holds JSON payloads. Define each
type with
payload_codec=JSON_PAYLOAD_CODECto read it, or write it as a new store withconvert(source, destination, definitions). Stop every writer of the source first.destinationmust not exist; every record of the listed definitions is rewritten under the definitions' own codec, records of other types keep their bytes, and the new file is fsynced before the call returns. Open it with the default definitions, then swap it in yourself. The source is never written. A refused record raisesCultCacheErrornaming the type, record key and code, and leaves no destination; a killed run leaves the source as it was and a partial destination, so delete the destination and run again. - A JSON payload that is a single digit (
0to9) is also a valid one-byte MessagePack integer and reads as 48 to 57 under the default, with no refusal. Only a document whose whole value is such a digit meets this; objects, lists and longer numbers never do. - A
PayloadCodecyou build owns the nesting depth of nodes the library's walk cannot see (anything that is not a mapping, sequence or set), and may raisePayloadCodecFault(code, kind)for a key or integer its format cannot carry.
DatabaseEntry Slot Contract
For cross-runtime cache entries, use define_database_entry_type(...), which
fixes the MessagePack slot-array payload:
from dataclasses import dataclass
from cultcache_py import define_database_entry_type
@dataclass
class Settings:
theme: str
retries: int = 0
settings_doc = define_database_entry_type(
"settings",
[
("theme", 0),
("retries", 1, 0),
],
cls=Settings,
)
The payload is a MessagePack array. Field keys are durable slot indexes:
- key
0writes array slot 0 - key
4writes array slot 4 - unused slots are written as nil
- deleted fields should leave their slots reserved
- newly added fields should use new keys
- fields with defaults tolerate missing or nil slots when older payloads are read
A payload carrying a slot past the slots a reader declares, at any depth (the document, a nested record, a list element, a
union arm, a unit arm), was written by a newer build. It is read, and the record is held read-only: put, update,
put_envelope(s), delete and their global forms refuse its key with SchemaConflictError before any store is touched, and
SchemaConflictError.unread_slots is an UnreadSlots(type_name, slot_count, declared_count, occurrences, depth0_only) naming the
first type read with extra slots (never a slot value). CultCache.is_writable(document, key) answers the same question before
the write: False for such a record, for a key a store carries foreign, and for a key held as another type's record; the write
still decides. DocumentDefinition.decode_payload_marked(payload) returns the value and its UnreadSlots (or None). Declaring the
stored id in compatible_schema_ids consents to the loss of depth-0 slots that id's catalog entry reports; a nested mark never is.
A store keeps a read-only record's bytes through every other write. A document with a custom decode never marks.
That matches the Rust #[derive(DatabaseEntry)] formatter shape and the C#
[Key(n)] intent: schema evolution comes from stable field slots, not source
member order.
Typed Leaves
A slot with no codec is untyped: it is an object in C#, cataloged System.Object, and takes any MessagePack value.
Give a slot a leaf from cultcache_py.leaves and it writes and reads exactly what the C# type does, refuses the rest
on write and on read, and carries the C# type name in the schema catalog, which the C# reference checks against its
own class.
from cultcache_py import database_entry_field, define_database_entry_type, leaves as t
settings_doc = define_database_entry_type(
"settings",
[
database_entry_field("theme", 0, codec=t.string),
database_entry_field("retries", 1, codec=t.int32, default=0),
database_entry_field("tags", 2, codec=t.list(t.string), default=list),
],
)
| Leaf | C# type | Python value |
|---|---|---|
t.string |
string |
str |
t.boolean |
bool |
bool |
t.bytes |
byte[] |
bytes, bytearray, memoryview; a MessagePack str reads as its UTF-8 bytes |
t.int32, t.int64 |
int, long |
int within range (not bool, not float) |
t.float32, t.float64 |
float, double |
int or float; a float32 is written as MessagePack float 32 |
t.list(x) |
List<T> |
list or tuple, each element through x |
t.array(x) |
T[] |
the same wire as t.list(x) |
t.any |
object |
any plain MessagePack value or a timestamp; the default of an untyped slot |
t.nullable(x) |
T? |
None, or whatever x takes |
t.lazy(get) |
a leaf resolved on first use, for a union that refers to itself |
Nil is refused unless the slot is wrapped in t.nullable. Wrap a C# string, byte[], List, array, class or
interface slot that may hold null (t.nullable(t.string)), and a value type that may hold null (int? is
t.nullable(t.int32), cataloged System.Nullable<System.Int32>); a reference type keeps its own name. A default
fills a slot the payload is too short to have, never a nil that is present.
A record or union is named for C# with type_name=, the class's FullName (a nested class joins with +):
inner = define_record_codec("Inner", [database_entry_field("n", 0, codec=t.string)], type_name="My.App.Doc+Inner")
shape = define_union("Shape", {0: ("Circle", circle)}, type_name="My.App.Doc+IShape")
Without type_name= the slot is cataloged System.Object. A refusal reads <type> slot <key> (<field>): expected <what>, found <kind>, prefixed element <i>: inside a list and Union '<name>' arm <key>: inside a union, and never
carries the value.
Wire Parity
Bytes match the C# reference for typed slots. An untyped (object) slot differs in
what it writes: C# writes a boxed integer 1 as d2 00000001, this runtime writes the
fixint 01; each runtime reads the other's bytes.
See docs/python-runtime-parity.md for the evidence map across the three Python packages.
The store interop peer is cultcache_py.interop:
python -m cultcache_py.interop write --file cache.cc --runtime-id python
python -m cultcache_py.interop read --file cache.cc
One deliberate exception to leaf acceptance following the reference: Python reads float32 and float64 map keys as
one float, so a map holding a float32 NaN key beside a float64 NaN key is refused on read and on write as
duplicate_map_key. C# reads that map as two keys, from the bytes 82 ca ffc00000 01 cb fff8000000000000 02 (fixint
values) and from the bytes it writes itself, 82 ca ffc00000 d2 00000001 cb fff8000000000000 d2 00000002 (float.NaN
and double.NaN keys with values 1 and 2, written as int32); every pair of NaN keys of one width is refused by both runtimes.
packages/cultcache-ts/test/cult-cache.test.ts includes Python in the shared
CultCache v1 parity matrix with TypeScript, Rust, and C#. cultcache_py ships
a py.typed marker so downstream type checkers can inspect the package surface.
Tests
$env:PYTHONPATH="$PWD\packages\cultcache-py\src"
python -m unittest discover -s packages\cultcache-py\tests
The suite runs with only this package on the path. If a test here needs
cultnet_py or cultmesh_py, it belongs in that package.