tapestry-orm 0.0.2__tar.gz → 0.0.4__tar.gz

{tapestry_orm-0.0.2 → tapestry_orm-0.0.4}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: tapestry-orm
-Version: 0.0.2
+Version: 0.0.4
 Summary: A prototype ORM for SurrealDB
 Author-email: timothee@obrecht.xyz
 License-Expression: MIT
 Requires-Dist: more-itertools>=10.7.0
 Requires-Dist: pydantic>=2.11.7
-Requires-Dist: surrealdb>=1.0.6
+Requires-Dist: surrealdb==2.0.0a1
 Requires-Dist: sphinx>=7.2.0 ; extra == 'docs'
 Requires-Dist: sphinx-rtd-theme>=2.0.0 ; extra == 'docs'
 Requires-Dist: sphinx-autodoc-typehints>=2.0.0 ; extra == 'docs'
@@ -15,7 +15,7 @@ Requires-Dist: myst-parser>=2.0.0 ; extra == 'docs'
 Requires-Dist: sphinx-autobuild>=2021.3.14 ; extra == 'docs'
 Requires-Dist: sphinx-autoapi>=3.0.0 ; extra == 'docs'
 Requires-Python: >=3.12
-Project-URL: Documentation, https://readthedocs.org
+Project-URL: Documentation, https://tapestry.readthedocs.io/en/latest/
 Project-URL: Repository, https://gitlab.com/timete_OS/tapestry-orm
 Provides-Extra: docs
 Description-Content-Type: text/markdown
@@ -338,9 +338,6 @@ Works with **mypy** and **pyright** for catching errors at build time!
 # Run all tests
 uv run pytest
 
-# Run with coverage
-uv run pytest --cov=tapestry
-
 # Run specific test
 uv run pytest tests/test_complete.py::TestWorkflow::test_select_queries
 ```
@@ -363,11 +360,7 @@ This gives you an identical testing experience to the actual CI pipeline, ensuri
 ### Type Checking
 
 ```bash
-# With mypy
-uv run mypy src/tapestry
-
-# With pyright
-uv run pyright src/tapestry
+uv run basedpyright src/tapestry
 ```
 
 ### Building Documentation

{tapestry_orm-0.0.2 → tapestry_orm-0.0.4}/README.md

@@ -316,9 +316,6 @@ Works with **mypy** and **pyright** for catching errors at build time!
 # Run all tests
 uv run pytest
 
-# Run with coverage
-uv run pytest --cov=tapestry
-
 # Run specific test
 uv run pytest tests/test_complete.py::TestWorkflow::test_select_queries
 ```
@@ -341,11 +338,7 @@ This gives you an identical testing experience to the actual CI pipeline, ensuri
 ### Type Checking
 
 ```bash
-# With mypy
-uv run mypy src/tapestry
-
-# With pyright
-uv run pyright src/tapestry
+uv run basedpyright src/tapestry
 ```
 
 ### Building Documentation

{tapestry_orm-0.0.2 → tapestry_orm-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tapestry-orm"
-version = "0.0.2"
+version = "0.0.4"
 description = "A prototype ORM for SurrealDB"
 readme = "README.md"
 license = "MIT"
@@ -13,11 +13,11 @@ requires-python = ">=3.12"
 dependencies = [
     "more-itertools>=10.7.0",
     "pydantic>=2.11.7",
-    "surrealdb>=1.0.6",
+    "surrealdb==2.0.0-alpha.1",
 ]
 [project.urls]
 Repository = "https://gitlab.com/timete_OS/tapestry-orm"
-Documentation = "https://readthedocs.org"
+Documentation = "https://tapestry.readthedocs.io/en/latest/"
 
 [project.optional-dependencies]
 docs = [

{tapestry_orm-0.0.2 → tapestry_orm-0.0.4}/src/tapestry/__init__.py

@@ -1,11 +1,9 @@
-__all__ = [
-    "Base", "Text", "create_engine", "create_engine_context", "Engine", "Reference", "Node", "Edge", "Q"
-]
+__all__ = ["Base", "Text", "create_engine", "create_engine_context", "Engine", "Reference", "Indexed", "Node", "Edge", "Q"]
 
 from .query import Q
 from .base import Base
 from .node import Node
 from .edge import Edge
 from .tokenizer import Text
-from .table import Reference
+from .table import Reference, Indexed
 from .engine import create_engine, create_engine_context, Engine

{tapestry_orm-0.0.2 → tapestry_orm-0.0.4}/src/tapestry/base.py

@@ -9,7 +9,7 @@ from copy import deepcopy
 from itertools import chain
 from queue import LifoQueue
 from surrealdb import RecordID
-from typing import  Any, ClassVar, Unpack, get_origin, get_args
+from typing import Any, ClassVar, Unpack, get_origin, get_args
 from pydantic_core.core_schema import ValidationInfo
 from pydantic.fields import FieldInfo, ComputedFieldInfo
 from pydantic import BaseModel, field_validator, model_serializer, Field, ConfigDict
@@ -57,12 +57,13 @@ class Base(BaseModel):
         - Handles enum serialization automatically
         - Provides full-text search capabilities with Text fields
     """
-    id: RecordID | None = Field(exclude=False, default = None)
+
+    id: RecordID | None = Field(exclude=False, default=None)
 
     model_config: ClassVar[ConfigDict] = ConfigDict(
         arbitrary_types_allowed=True,
-        use_enum_values=False, # would be great to have a 'use_enum_names'
-        validate_assignment=True
+        use_enum_values=False,  # would be great to have a 'use_enum_names'
+        validate_assignment=True,
     )
     _registry: ClassVar[tuple[Table, ...]] = ()
     _tokenizers: ClassVar[set[str]] = set()
@@ -70,9 +71,8 @@ class Base(BaseModel):
     _discarded: ClassVar[bool] = False
     child_classes: ClassVar[dict[str, type[Base]]] = {}
 
-
     @classmethod
-    @field_validator('id')
+    @field_validator("id")
     def validate_record_id(cls, v: Any) -> RecordID | None:
         """
         Validate and convert record ID values.
@@ -94,7 +94,6 @@ class Base(BaseModel):
         # Convert string to RecordID if needed
         return RecordID(cls.__name__.lower(), v)
 
-
     @model_serializer(mode="wrap")
     def _serialize(self, serializer, info):
         """
@@ -125,8 +124,7 @@ class Base(BaseModel):
                 # maybe check here in context if we are inserting in db
             return self.id
 
-
-    @field_validator('*', mode='before')
+    @field_validator("*", mode="before")
     @classmethod
     def validate_enums(cls, v: Any, info: ValidationInfo) -> Any:
         """
@@ -165,7 +163,6 @@ class Base(BaseModel):
         #     return stub
         return v
 
-
     def __init_subclass__(cls, **kwargs: Unpack[ConfigDict]):
         discarded = kwargs.pop("discarded", False)
         # Create unique queue for each subclass
@@ -174,7 +171,6 @@ class Base(BaseModel):
         cls._discarded = bool(discarded)
         return super().__init_subclass__(**kwargs)
 
-
     @classmethod
     def __pydantic_init_subclass__(cls, **kwargs):
         relation = kwargs.pop("relation", None)
@@ -190,7 +186,9 @@ class Base(BaseModel):
         for field_name, field_info in model_fields.items():
             field_type = field_info.annotation if isinstance(field_info, FieldInfo) else field_info.return_type
             if isinstance(field_info, ComputedFieldInfo):
-                field_descriptor = ComputedFieldDescriptor[field_type](field_name, cls.__name__.lower(), field_type or Any, getattr(cls, field_name, None))
+                field_descriptor = ComputedFieldDescriptor[field_type](
+                    field_name, cls.__name__.lower(), field_type or Any, getattr(cls, field_name, None)
+                )
             else:
                 field_descriptor = CustomField[field_type](field_name, cls.__name__.lower(), field_type or Any)
             fields.append(field_descriptor)
@@ -199,15 +197,19 @@ class Base(BaseModel):
             nested_class = None
             try:
                 # Check if it's a Base subclass directly
-                if field_type and hasattr(field_type, '__mro__') and Base in field_type.__mro__:
+                if field_type and hasattr(field_type, "__mro__") and Base in field_type.__mro__:
                     nested_class = field_type
                 # Check if it's Optional[Base subclass] (Union with None)
-                elif get_origin(field_type) is types.UnionType or (get_origin(field_type) is not None and hasattr(get_origin(field_type), '__name__') and get_origin(field_type).__name__ == 'UnionType'):
+                elif get_origin(field_type) is types.UnionType or (
+                    get_origin(field_type) is not None
+                    and hasattr(get_origin(field_type), "__name__")
+                    and get_origin(field_type).__name__ == "UnionType"
+                ):
                     # Get the args of the Union
                     args = get_args(field_type)
                     # Filter out None and check if any remaining type is a Base subclass
                     for arg in args:
-                        if arg is not type(None) and hasattr(arg, '__mro__') and Base in arg.__mro__:
+                        if arg is not type(None) and hasattr(arg, "__mro__") and Base in arg.__mro__:
                             nested_class = arg
                             break
 
@@ -223,8 +225,9 @@ class Base(BaseModel):
 
             # replace Base instance with Union[annotation, RecordID]
             if field_name in cls.model_fields:
-                cls.model_fields[field_name].annotation = replace_type(cls.model_fields[field_name].annotation, Base, Base | RecordID)
-
+                cls.model_fields[field_name].annotation = replace_type(
+                    cls.model_fields[field_name].annotation, Base, Base | RecordID
+                )
 
         table = Table(name=cls.__name__.lower(), base_class=Base, model_class=cls, fields=tuple(fields), relation=relation)
         for tokenizer in table.tokenizers:
@@ -235,7 +238,6 @@ class Base(BaseModel):
         Base.add_table(table, cls)
         cls.model_rebuild(force=True)
 
-
     @classmethod
     def registered_tables(cls) -> set[str]:
         """
@@ -251,7 +253,6 @@ class Base(BaseModel):
         """
         return {f.name for f in cls._registry}
 
-
     @classmethod
     def add_table(cls, table: Table, child_class: type[Base]):
         """
@@ -265,10 +266,9 @@ class Base(BaseModel):
             This is called automatically when subclasses are defined.
             Users typically don't need to call this directly.
         """
-        cls._registry = tuple(t for t in chain(cls._registry, (table, )))
+        cls._registry = tuple(t for t in chain(cls._registry, (table,)))
         cls.child_classes[table.name] = child_class
 
-
     @classmethod
     def registered_models(cls) -> list[Table]:
         """
@@ -284,7 +284,6 @@ class Base(BaseModel):
         """
         return list(cls._registry)
 
-
     @classmethod
     def generate_schema(cls) -> str:
         """
@@ -314,7 +313,6 @@ class Base(BaseModel):
         blocks = [t.generate_table_sql() for t in cls._registry]
         return "\n\n".join(chain(cls._tokenizers, blocks))
 
-
     @classmethod
     def deserialize_record(cls, data: dict) -> Any:
         """
@@ -331,7 +329,7 @@ class Base(BaseModel):
             if no matching model is found
 
         Notes:
-            - Handles edge records by converting 'in' and 'out' to 'in_' and 'out_'
+            - Handles edge records by converting ``in`` and ``out`` to ``in_`` and ``out_``
             - Automatically determines the model class from the record ID
             - Validates data using Pydantic validation
         """
@@ -343,7 +341,7 @@ class Base(BaseModel):
             data["out_"] = data.pop("out", None)
 
         # Get the model class from the record ID
-        record_id = data.get('id')
+        record_id = data.get("id")
         if not record_id or not isinstance(record_id, RecordID):
             return data
 
@@ -355,7 +353,6 @@ class Base(BaseModel):
         # here maybe specify if the users wants related records as ids or full objects
         return model_class.model_validate(data, context="could this parameter be of any use ?")
 
-
     @classmethod
     def deserialize_response(cls, response: Any) -> Any:
         """
@@ -381,7 +378,6 @@ class Base(BaseModel):
             return cls.deserialize_record(response)
         return response
 
-
     def db_dump(self) -> dict[str, Any]:
         """
         Serialize the model instance for database insertion/update.
@@ -400,6 +396,6 @@ class Base(BaseModel):
             >>> await db.create("person", data)
         """
         serialized = self.model_dump(context={"root": True})
-        serialized.pop('id', None)
+        serialized.pop("id", None)
         # this convert_types fonction is only here
         return convert_types(serialized)

{tapestry_orm-0.0.2 → tapestry_orm-0.0.4}/src/tapestry/edge.py

@@ -1,15 +1,13 @@
 from abc import ABC
-from copy import deepcopy
-from typing import Self, Iterable, get_type_hints, Any, ClassVar, TYPE_CHECKING
-from pydantic.fields import FieldInfo, ComputedFieldInfo
+from typing import Self, Iterable, get_type_hints, Any
 from surrealdb import AsyncWsSurrealConnection, AsyncHttpSurrealConnection, RecordID
 
 
 from .base import Base
 from .node import Node
 from .utils import replace_type
-from .table import Table, Link, flatten_type
-from .field import Traversal, Direction, Condition, LogicalCondition, Field
+from .table import Link, flatten_type
+from .field import Traversal, Direction
 
 
 class Edge(Base, ABC, discarded=True):
@@ -18,14 +16,14 @@ class Edge(Base, ABC, discarded=True):
 
     Edge represents relationship tables in SurrealDB that connect two nodes.
     All relationship tables should inherit from this class and define
-    'in_' and 'out_' fields to specify the connected node types.
+    ``in_`` and ``out_`` fields to specify the connected node types.
 
     Class Attributes:
         _directed (bool): Whether the relationship is directional (default: True)
 
     Required Fields:
-        in_: The source node of the relationship
-        out_: The target node of the relationship
+        ``in_``: The source node of the relationship
+        ``out_``: The target node of the relationship
 
     Example:
         >>> from tapestry import Edge, Node
@@ -54,12 +52,13 @@ class Edge(Base, ABC, discarded=True):
         >>> await belongs.relate(db)
 
     Notes:
-        - Requires both 'in_' and 'out_' fields to be defined
+        - Requires both ``in_`` and ``out_`` fields to be defined
         - Automatically creates SurrealDB RELATION tables
         - Supports directional and bidirectional relationships
-        - Can have additional fields beyond in_ and out_
+        - Can have additional fields beyond ``in_`` and ``out_``
         - Use relate() instead of create() for edge records
     """
+
     # in_: Node
     # out_: Node
     #
@@ -76,7 +75,7 @@ class Edge(Base, ABC, discarded=True):
             **kwargs: Additional configuration passed to parent
 
         Raises:
-            TypeError: If the subclass doesn't define both 'in_' and 'out_' fields
+            TypeError: If the subclass doesn't define both ``in_`` and ``out_`` fields
         """
         super().__init_subclass__(**kwargs)
 
@@ -84,20 +83,17 @@ class Edge(Base, ABC, discarded=True):
         hints = get_type_hints(cls)
 
         # Check if required fields are annotated
-        required_fields = {'in_', 'out_'}
+        required_fields = {"in_", "out_"}
         missing_fields = required_fields - set(hints.keys())
         if missing_fields:
-            raise TypeError(
-                f"Class {cls.__name__} must have field annotations for: {missing_fields}"
-            )
+            raise TypeError(f"Class {cls.__name__} must have field annotations for: {missing_fields}")
 
         cls._directed = directed
 
-
     @classmethod
     def __pydantic_init_subclass__(cls, **kwargs):
         relation = None
-        in_, out_ = cls.model_fields.pop('in_', None), cls.model_fields.pop('out_', None)
+        in_, out_ = cls.model_fields.pop("in_", None), cls.model_fields.pop("out_", None)
         if in_ or out_:
             if in_ and out_:
                 assert in_.annotation
@@ -119,14 +115,12 @@ class Edge(Base, ABC, discarded=True):
         cls.model_fields["out_"] = out_
         cls.model_rebuild(force=True)
 
-
-
     def db_dump(self) -> dict[str, Any]:
         """
         Serialize the edge instance for database insertion.
 
         Converts Python field names to SurrealDB format by renaming
-        'in_' to 'in' and 'out_' to 'out'.
+        ``in_`` to ``in`` and ``out_`` to ``out``.
 
         Returns:
             dict[str, Any]: Dictionary ready for SurrealDB relation operations
@@ -136,11 +130,7 @@ class Edge(Base, ABC, discarded=True):
         dump["out"] = dump.pop("out_")
         return dump
 
-
-    async def relate(
-        self,
-        db: AsyncWsSurrealConnection | AsyncHttpSurrealConnection
-    ) -> Self:
+    async def relate(self, db: AsyncWsSurrealConnection | AsyncHttpSurrealConnection) -> Self:
         """
         Create a relationship record in the database.
 
@@ -168,29 +158,22 @@ class Edge(Base, ABC, discarded=True):
             Exception: If called on a non-relation table
 
         Notes:
-            - Both in_ and out_ nodes must exist in the database
+            - Both ``in_`` and ``out_`` nodes must exist in the database
             - Creates a directed or bidirectional edge based on class configuration
             - The edge record gets a unique ID from SurrealDB
         """
         if not self.is_relation:
             raise Exception("You should use .create() to create a record")
         thing = self.__class__.__name__.lower()
-        relation = await db.insert_relation(
-            thing,
-            self.db_dump()
-        )
+        relation = await db.insert_relation(thing, self.db_dump())
         if isinstance(relation, list):
             self.id = relation[0]["id"]
         else:
             self.id = relation["id"]
         return self
 
-
     @classmethod
-    async def insert(
-        cls,
-        db: AsyncWsSurrealConnection | AsyncHttpSurrealConnection, others: Iterable[Self]
-    ) -> list[Self]:
+    async def insert(cls, db: AsyncWsSurrealConnection | AsyncHttpSurrealConnection, others: Iterable[Self]) -> list[Self]:
         """
         Batch insert multiple edge records into the database.
 
@@ -218,10 +201,7 @@ class Edge(Base, ABC, discarded=True):
             - Original instances are modified with IDs
         """
         others = list(others)
-        inserted = await db.insert_relation(
-            cls.__name__.lower(),
-            [other.db_dump() for other in others]
-        )
+        inserted = await db.insert_relation(cls.__name__.lower(), [other.db_dump() for other in others])
         for insert, original in zip(inserted, others):
             original.id = insert["id"]
         return others