3tears 0.14.0__tar.gz

3tears-0.14.0/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Claude Code local state
+.claude/
+
+# prawduct session evidence (local governance artifacts, never shipped)
+.prawduct/
+
+# macOS folder metadata
+.DS_Store

3tears-0.14.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mark Pace
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

3tears-0.14.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: 3tears
+Version: 0.14.0
+Summary: Three-tier caching framework for Python -- L1 SQLite, L2 NATS KV, L3 PostgreSQL
+Project-URL: Repository, https://github.com/pacepace/3tears
+Author: pace
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Requires-Dist: 3tears-nats
+Requires-Dist: 3tears-observe
+Requires-Dist: aiosqlite
+Requires-Dist: asyncpg
+Requires-Dist: cryptography>=42
+Requires-Dist: nats-py
+Requires-Dist: pydantic
+Requires-Dist: pyjwt[crypto]>=2.8
+Requires-Dist: sqlalchemy
+Provides-Extra: duckdb
+Requires-Dist: duckdb>=1.0; extra == 'duckdb'
+Provides-Extra: testing
+Requires-Dist: docker>=7.0; extra == 'testing'
+Requires-Dist: pytest>=8.0; extra == 'testing'
+Requires-Dist: testcontainers[nats,postgres]>=4.0; extra == 'testing'
+Provides-Extra: tracing
+Requires-Dist: opentelemetry-api>=1.20; extra == 'tracing'
+Description-Content-Type: text/markdown
+
+# 3tears Core
+
+Three-tier caching library for Python applications. Provides collections (L1 SQLite -> L2 NATS KV -> L3 PostgreSQL) with subscript access, entity proxy objects, and configurable flush strategies.
+
+## Architecture
+
+```
+L1 (SQLite, in-process, sync)  ->  L2 (NATS KV, shared, async)  ->  L3 (PostgreSQL, persistent, async)
+```
+
+- **L1**: In-memory SQLite via WAL mode. Sync access. Used by entity attribute reads and writes.
+- **L2**: NATS KV shared cache. Async. Cross-pod consistency for multi-instance deployments.
+- **L3**: PostgreSQL (or PostGIS, YugabyteDB, etc.). Async. Source of truth.
+
+Reads promote up the stack (L3 miss -> L2 miss -> L1 hit on next access). Writes flow down (L1 -> L2 -> L3, with optional deferred flush).
+
+## Quick Start
+
+### 1. Configure the Registry
+
+```python
+from threetears.core.collections.registry import CollectionRegistry
+from threetears.core.cache.sqlite import SQLiteBackend
+
+# Create and configure
+l1 = SQLiteBackend("my_app_cache")
+l1.initialize(sa_metadata)  # SQLAlchemy metadata with your table definitions
+
+registry = CollectionRegistry()
+registry.configure(
+    l1_backend=l1,          # SQLiteBackend instance
+    l2_client=nats_client,  # NATS client (optional, None to skip L2)
+    l3_pool=postgres_pool,  # asyncpg pool
+)
+```
+
+### 2. Per-Collection Pool Overrides
+
+Different collections can use different databases:
+
+```python
+# Default: all collections use YugabyteDB
+registry.configure(l3_pool=yugabyte_pool)
+
+# Override: geo collection uses PostGIS
+registry.configure()  # keep defaults
+# When creating the collection, register with override:
+geo_collection = GeoCollection(registry, config, nats_client, write_buffer)
+registry.register(geo_collection, l3_pool=postgis_pool)
+```
+
+### 3. Define a Collection
+
+```python
+from threetears.core.collections.base import BaseCollection
+from threetears.core.entities.base import BaseEntity
+
+class UserEntity(BaseEntity):
+    primary_key_field = "user_id"
+
+class UsersCollection(BaseCollection[UserEntity]):
+    primary_key_column = "user_id"
+
+    @property
+    def table_name(self) -> str:
+        return "users"
+
+    @property
+    def entity_class(self) -> type[UserEntity]:
+        return UserEntity
+
+    async def fetch_from_store(self, entity_id):
+        row = await self.l3_pool.fetchrow(
+            "SELECT * FROM users WHERE user_id = $1", entity_id
+        )
+        return dict(row) if row else None
+
+    async def save_to_store(self, data, original_timestamp=None):
+        # INSERT or UPDATE with optimistic locking
+        ...
+
+    async def delete_from_store(self, entity_id):
+        await self.l3_pool.execute(
+            "DELETE FROM users WHERE user_id = $1", entity_id
+        )
+
+    def serialize(self, data):
+        return json.dumps(data, default=str).encode()
+
+    def deserialize(self, data):
+        return json.loads(data)
+```
+
+### 4. Create Collection Instances
+
+```python
+from threetears.core.collections.flush import WriteBuffer
+
+write_buffer = WriteBuffer()
+users = UsersCollection(registry, config, nats_client, write_buffer)
+```
+
+The `config` parameter must satisfy the `CoreConfig` protocol:
+
+```python
+class CoreConfig(Protocol):
+    collection_flush: str           # "ALWAYS", "ON_CHECKPOINT", "ON_SCHEDULE", "ON_SHUTDOWN"
+    collection_flush_interval: int  # seconds between scheduled flushes
+    collection_flush_tables: str    # comma-separated table names eligible for deferred flush
+```
+
+## Access Patterns
+
+### Subscript Access (sync, transparent pull-through)
+
+Subscript access is the primary API. On L1 miss, data is transparently pulled through L2/L3 via a background event loop. No `await` needed, no `ensure()` required:
+
+```python
+# Read entity -- pulls through L2/L3 automatically on L1 miss
+entity = users[user_id]
+
+# Read single field
+name = users[user_id, "name_display"]
+
+# Write single field (writes to L1, tracks for flush)
+users[user_id, "name_display"] = "New Name"
+
+# Write full entity data (writes dict to L1)
+users[user_id] = {"user_id": user_id, "name_display": "New Name", ...}
+
+# Check if entity is in L1 (does NOT pull through -- L1 only)
+if user_id in users:
+    entity = users[user_id]
+```
+
+`__getitem__` raises `KeyError` only if the entity doesn't exist in any tier. The L1 fast path is ~microseconds; an L1 miss with pull-through adds ~50-200us bridge overhead plus the actual L2/L3 I/O time.
+
+
+For hot-path code where you want to avoid the sync-async bridge overhead on first access, you can pre-warm L1:
+
+```python
+await users.ensure(user_id)  # async: pre-warms L1
+entity = users[user_id]       # guaranteed L1 hit, no bridge needed
+```
+
+### Async Operations
+
+```python
+# Three-tier read: L1 -> L2 -> L3, promotes on miss. Returns None if not found.
+entity = await users.get(user_id)
+
+# Create a new entity (not persisted until save)
+entity = users.create({"user_id": uuid7(), "name_display": "Alice", ...})
+
+# Save through three-tier write path (L3 -> L1 -> L2)
+await users.save_entity(entity)
+# Or via entity directly:
+await entity.save()
+
+# Reload from L3 (discards local changes)
+await entity.reload()
+
+# Delete from all tiers
+await users.delete(user_id)
+
+# Invalidate L1 + L2 (force next read to hit L3)
+await users.invalidate_cache(user_id)
+```
+
+### Entity Attribute Access
+
+Entities are thin cache proxies. Field data lives in L1, not in the entity object.
+
+```python
+entity = await users.get(user_id)
+
+# Read (checks entity._changes first, then L1 cache)
+print(entity.name_display)
+
+# Write (writes to L1 + tracks change)
+entity.name_display = "Updated Name"
+
+# Check dirty state
+entity.is_dirty  # True after modification
+entity.is_new    # True if created via collection.create()
+
+# Get all changes
+entity.get_changes()  # {"name_display": "Updated Name"}
+
+# Export full entity data from L1
+entity.to_dict()
+
+# Persist
+await entity.save()
+```
+
+## Flush Strategies
+
+Controls when deferred writes reach L3 (PostgreSQL):
+
+| Strategy | Behavior |
+|---|---|
+| `ALWAYS` | Every `save_entity()` writes to L3 immediately |
+| `ON_CHECKPOINT` | Writes buffer to L1 + L2; flushes to L3 on explicit `flush_pending()` call |
+| `ON_SCHEDULE` | Same as ON_CHECKPOINT but with timer-based auto-flush |
+| `ON_SHUTDOWN` | Writes buffer; flushes to L3 on application shutdown |
+
+Only tables listed in `collection_flush_tables` are eligible for deferred writes. All other tables always write immediately regardless of strategy.
+
+## Optimistic Locking
+
+Collections use `date_updated` for optimistic locking. When saving an existing entity, the `save_to_store` implementation should check:
+
+```sql
+UPDATE users SET ... WHERE user_id = $1 AND date_updated = $2
+```
+
+If `rows_affected == 0` for an UPDATE, `BaseCollection.save_entity()` raises `ConcurrentModificationError`.
+
+## Subclassing Guide
+
+**BaseEntity**: Set `primary_key_field` to your PK column name. Add computed properties as needed. Do NOT store data in instance attributes. All data lives in L1.
+
+**BaseCollection**: Set `primary_key_column`. Implement the 5 abstract methods: `fetch_from_store`, `save_to_store`, `delete_from_store`, `serialize`, `deserialize`. Use `self.l3_pool` for database access. Add domain-specific query methods (e.g., `find_by_email`).