glyff 0.1.0__tar.gz

glyff-0.1.0/.gitignore

@@ -0,0 +1,210 @@
+# 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__/
+
+/out/
+/.local/

glyff-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 nueruyu
+
+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.

glyff-0.1.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: glyff
+Version: 0.1.0
+Summary: Guaranteed Lightweight Yieldable Function Foundation for checkpointed and resumable task execution.
+License: MIT License
+        
+        Copyright (c) 2026 nueruyu
+        
+        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.
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# glyff
+
+**G**uaranteed **L**ightweight **Y**ieldable **F**unction **F**oundation.
+
+A primitive for pausing async functions across process and request boundaries,
+and resuming them later from the same point.
+
+## Install
+
+```bash
+pip install glyff
+```
+
+`glyff` has no dependencies beyond the Python standard library.
+
+## Behavior
+
+- Marked function calls are recorded in a session-scoped store, keyed by
+  function identity, arguments, and call position.
+- Re-invoking the same call within the same session returns the recorded
+  result instead of re-executing.
+- A call's outcome — success or failure — is permanent once recorded.
+- `YieldException` suspends execution at a function boundary; the session
+  can be resumed later by entering it again with the same session id.
+
+## Public API
+
+| Name              | Description                                                     |
+| ----------------- | --------------------------------------------------------------- |
+| `engrave`         | Decorator that marks an async function for recording.           |
+| `Session`         | Async context manager that scopes a sequence of engraved calls. |
+| `ExecutionId`     | Identifier for a recorded function execution.                   |
+| `ExecutionRecord` | Persisted execution state and result.                           |
+| `ExecutionStatus` | Enum: `STARTED`, `COMPLETED`, `FAILED`.                         |
+| `SessionStore`    | Protocol for storage backends.                                  |
+| `Serializer`      | Protocol for value serialization.                               |
+| `ArgsHasher`      | Protocol for argument hashing.                                  |
+| `YieldException`  | Raised to suspend a session.                                    |
+
+## Extending
+
+- For persistent storage, see [`glyff-file-store`](https://pypi.org/project/glyff-file-store/).
+- For Pydantic-typed serialization, see [`glyff-pydantic`](https://pypi.org/project/glyff-pydantic/).
+- Custom backends can be written by implementing the `SessionStore`,
+  `Serializer`, and `ArgsHasher` protocols.
+
+## Status
+
+Early development. APIs may change before v1.0.
+
+## License
+
+MIT

glyff-0.1.0/README.md

@@ -0,0 +1,53 @@
+# glyff
+
+**G**uaranteed **L**ightweight **Y**ieldable **F**unction **F**oundation.
+
+A primitive for pausing async functions across process and request boundaries,
+and resuming them later from the same point.
+
+## Install
+
+```bash
+pip install glyff
+```
+
+`glyff` has no dependencies beyond the Python standard library.
+
+## Behavior
+
+- Marked function calls are recorded in a session-scoped store, keyed by
+  function identity, arguments, and call position.
+- Re-invoking the same call within the same session returns the recorded
+  result instead of re-executing.
+- A call's outcome — success or failure — is permanent once recorded.
+- `YieldException` suspends execution at a function boundary; the session
+  can be resumed later by entering it again with the same session id.
+
+## Public API
+
+| Name              | Description                                                     |
+| ----------------- | --------------------------------------------------------------- |
+| `engrave`         | Decorator that marks an async function for recording.           |
+| `Session`         | Async context manager that scopes a sequence of engraved calls. |
+| `ExecutionId`     | Identifier for a recorded function execution.                   |
+| `ExecutionRecord` | Persisted execution state and result.                           |
+| `ExecutionStatus` | Enum: `STARTED`, `COMPLETED`, `FAILED`.                         |
+| `SessionStore`    | Protocol for storage backends.                                  |
+| `Serializer`      | Protocol for value serialization.                               |
+| `ArgsHasher`      | Protocol for argument hashing.                                  |
+| `YieldException`  | Raised to suspend a session.                                    |
+
+## Extending
+
+- For persistent storage, see [`glyff-file-store`](https://pypi.org/project/glyff-file-store/).
+- For Pydantic-typed serialization, see [`glyff-pydantic`](https://pypi.org/project/glyff-pydantic/).
+- Custom backends can be written by implementing the `SessionStore`,
+  `Serializer`, and `ArgsHasher` protocols.
+
+## Status
+
+Early development. APIs may change before v1.0.
+
+## License
+
+MIT

glyff-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "glyff"
+description = "Guaranteed Lightweight Yieldable Function Foundation for checkpointed and resumable task execution."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.11"
+dependencies = []
+dynamic = ["version"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Typing :: Typed",
+]
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/glyff"]
+exclude = ["src/glyff/tests"]
+
+[tool.hatch.version]
+source = "vcs"
+raw-options = { root = "../.." }
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["src/glyff/tests"]
+
+[dependency-groups]
+dev = ["pytest>=8.0", "pytest-asyncio>=0.23", "pytest-mock>=3.12.0"]

glyff-0.1.0/src/glyff/__init__.py

@@ -0,0 +1,15 @@
+from .decorators import engrave
+from .interfaces import ArgsHasher, Serializer, SessionStore
+from .models import ExecutionId, ExecutionRecord, ExecutionStatus
+from .session import Session
+
+__all__ = [
+    "engrave",
+    "Session",
+    "ExecutionId",
+    "ExecutionRecord",
+    "ExecutionStatus",
+    "ArgsHasher",
+    "Serializer",
+    "SessionStore",
+]

glyff-0.1.0/src/glyff/context.py

@@ -0,0 +1,174 @@
+from __future__ import annotations
+
+import contextvars
+from collections.abc import Iterator, Sequence
+from typing import Callable, overload
+
+from .exceptions import ExecutionFailedError, YieldException
+from .interfaces import ArgsHasher, SessionStore, Transaction
+from .models import ExecutionId
+from .sequencer import Sequencer
+
+
+class Context:
+    """Holds the execution context for a workflow session."""
+
+    def __init__(
+        self,
+        session_id: str,
+        store: SessionStore,
+        sequencer: Sequencer,
+        hasher: ArgsHasher,
+        transaction_scope_factory: Callable[[], TransactionScope],
+    ) -> None:
+        self._session_id = session_id
+        self._store = store
+        self._sequencer = sequencer
+        self._hasher = hasher
+        self._transaction_scope_factory = transaction_scope_factory
+        self._tracer = ExecutionTracer()
+        self._current_transaction_scope: TransactionScope | None = None
+
+    @property
+    def store(self) -> SessionStore:
+        return self._store
+
+    @property
+    def sequencer(self) -> Sequencer:
+        return self._sequencer
+
+    @property
+    def hasher(self) -> ArgsHasher:
+        return self._hasher
+
+    @property
+    def tracer(self) -> ExecutionTracer:
+        return self._tracer
+
+    @property
+    def call_stack(self) -> CallStack:
+        return self._tracer.call_stack
+
+    @property
+    def current_execution_id(self) -> ExecutionId | None:
+        return self._tracer.current
+
+    @property
+    def in_transaction(self) -> bool:
+        """Returns True if currently within a transaction scope."""
+        ts = self._current_transaction_scope
+        return ts is not None and ts.in_transaction
+
+    def get_transaction_scope(self) -> TransactionScope:
+        if self._current_transaction_scope is None:
+            self._current_transaction_scope = self._transaction_scope_factory()
+        return self._current_transaction_scope
+
+
+class CallStack(Sequence[ExecutionId]):
+    """Read-only view of the execution call stack. No allocation on access."""
+
+    __slots__ = ("_data",)
+
+    def __init__(self, data: list[ExecutionId]) -> None:
+        self._data = data
+
+    @overload
+    def __getitem__(self, index: int) -> ExecutionId: ...
+    @overload
+    def __getitem__(self, index: slice) -> list[ExecutionId]: ...
+
+    def __getitem__(self, index):
+        return self._data[index]
+
+    def __len__(self) -> int:
+        return len(self._data)
+
+    def __contains__(self, item: object) -> bool:
+        return item in self._data
+
+    def __iter__(self) -> Iterator[ExecutionId]:
+        return iter(self._data)
+
+    def __repr__(self) -> str:
+        return f"CallStack({self._data!r})"
+
+
+class ExecutionTracer:
+    """Records the active call stack during workflow execution."""
+
+    def __init__(self) -> None:
+        self._stack: list[ExecutionId] = []
+        self._view = CallStack(self._stack)
+
+    @property
+    def call_stack(self) -> CallStack:
+        return self._view
+
+    @property
+    def current(self) -> ExecutionId | None:
+        return self._stack[-1] if self._stack else None
+
+    def start(self, execution_id: ExecutionId) -> None:
+        self._stack.append(execution_id)
+
+    def end(self) -> None:
+        self._stack.pop()
+
+
+class TransactionScope:
+    """
+    Manages a transaction across a SessionStore, supporting nesting.
+    The actual commit/rollback only happens at the outermost scope.
+    """
+
+    def __init__(self, store: SessionStore):
+        self._store = store
+        self._level = 0
+        self._transaction: Transaction | None = None
+
+    @property
+    def in_transaction(self) -> bool:
+        """Returns True if currently within a transaction scope."""
+        return self._level > 0
+
+    async def __aenter__(self):
+        if self._level == 0:
+            self._transaction = await self._store.begin_transaction()
+        self._level += 1
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        self._level -= 1
+        if self._level == 0 and self._transaction:
+            if exc_type is None or isinstance(
+                exc_val, (YieldException, ExecutionFailedError)
+            ):
+                # On YieldException or ExecutionFailedError we still commit so that
+                # state (completed subtasks or the failure record) is durably saved.
+                await self._transaction.commit()
+            else:
+                await self._transaction.rollback()
+
+
+_context_var: contextvars.ContextVar[Context] = contextvars.ContextVar("glyff_context")
+
+
+def get_context() -> Context:
+    """Retrieves the current workflow context."""
+    try:
+        return _context_var.get()
+    except LookupError:
+        raise RuntimeError(
+            "Workflow context is not set. Are you running outside a Session?"
+        )
+
+
+def set_context(ctx: Context) -> contextvars.Token:
+    """Sets the current workflow context. Returns a token that can be used to reset it."""
+    return _context_var.set(ctx)
+
+
+def reset_context(token: contextvars.Token) -> None:
+    """Resets the workflow context to a previous state using the provided token."""
+    _context_var.reset(token)

glyff-0.1.0/src/glyff/decorators.py

@@ -0,0 +1,51 @@
+import functools
+import inspect
+from typing import Any, Callable, ParamSpec, TypeVar, cast
+
+from .context import get_context
+from .executor import execute
+from .models import ExecutionId
+
+P = ParamSpec("P")
+R = TypeVar("R")
+
+
+def engrave(func: Callable[P, R]) -> Callable[P, R]:
+    """
+    Decorator that makes an async method engraveable and resumable.
+    Its main responsibilities are ExecutionId creation and delegation to the
+    `executor` module.
+    """
+    sig = inspect.signature(func)
+    task_name = getattr(func, "__qualname__", func.__name__)
+
+    try:
+        type_hints = inspect.get_annotations(func, eval_str=True)
+        return_type = type_hints.get("return", Any)
+    except Exception as e:
+        raise TypeError(
+            f"Could not resolve type hints for {task_name}. "
+            f"Please ensure all types are correctly defined and imported. Error: {e}"
+        ) from e
+
+    @functools.wraps(func)
+    async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+        ctx = get_context()
+        parent_id = ctx.current_execution_id
+        seq = await ctx.sequencer.next(parent_id, task_name)
+        args_hash = ctx.hasher.hash_args(func, sig, args, kwargs)
+        execution_id = ExecutionId(
+            parent_id=parent_id, name=task_name, sequence=seq, args_hash=args_hash
+        )
+
+        result = await execute(
+            ctx=ctx,
+            execution_id=execution_id,
+            func=func,
+            args=args,
+            kwargs=kwargs,
+            return_type=return_type,
+        )
+        return cast(R, result)
+
+    return cast(Callable[P, R], wrapper)

glyff-0.1.0/src/glyff/exceptions.py

@@ -0,0 +1,16 @@
+class YieldException(Exception):
+    """
+    A special exception to signal that the session should be interrupted gracefully.
+    This is not an error, but a signal to stop processing and engrave the state.
+    """
+
+    pass
+
+
+class ExecutionFailedError(Exception):
+    """
+    Raised when attempting to execute a task that has previously failed
+    and its failure state is engraved.
+    """
+
+    pass