surreal-orm-lite 0.2.0__tar.gz → 0.2.2__tar.gz

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/CHANGELOG.md

@@ -5,6 +5,39 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2026-02-05
+
+### Fixed
+
+- Corrected project URLs in package metadata (case sensitivity)
+
+## [0.2.1] - 2026-02-04
+
+### Fixed
+
+- Fixed `refresh()` method not updating the model instance
+- Fixed `refresh()` not handling SDK 1.0.8 list responses
+- Fixed `save()` not updating instance with auto-generated ID
+- Fixed SQL query order: `ORDER BY` now comes before `LIMIT/START` (SurrealDB requirement)
+- Fixed `set_data` validator not always returning data
+- Fixed typo in error message: `primirary_key` → `primary_key`
+- Removed ineffective `del self` in `delete()` method
+- Fixed dead test `failed_model_validation` that was never executed
+
+### Changed
+
+- `SurrealDbNotFoundError` now inherits from `SurrealDbError` for backward compatibility
+- Test database connection now configurable via `SURREALDB_HOST` and `SURREALDB_PORT` environment variables
+- Improved docstrings for `unset_connection()` and `is_password_set()`
+- Translated French comments to English in `connection_manager.py`
+- Renamed variable `test` → `result` in `update()` method
+
+### Added
+
+- Added `codecov.yml` configuration (disabled patch coverage check)
+- Added test for `save()` with auto-generated ID
+- Added test for `contains` lookup operator
+
 ## [0.2.0] - 2026-02-02
 
 ### Added

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: surreal-orm-lite
-Version: 0.2.0
+Version: 0.2.2
 Summary: Lightweight Django-style ORM for SurrealDB using the official Python SDK. Async support with Pydantic validation.
-Project-URL: Homepage, https://github.com/EulogySnowfall/surreal-orm-lite
-Project-URL: Documentation, https://github.com/EulogySnowfall/surreal-orm-lite
-Project-URL: Repository, https://github.com/EulogySnowfall/surreal-orm-lite.git
-Project-URL: Issues, https://github.com/EulogySnowfall/surreal-orm-lite/issues
-Project-URL: Changelog, https://github.com/EulogySnowfall/surreal-orm-lite/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://github.com/EulogySnowfall/SurrealDB-ORM-lite
+Project-URL: Documentation, https://github.com/EulogySnowfall/SurrealDB-ORM-lite
+Project-URL: Repository, https://github.com/EulogySnowfall/SurrealDB-ORM-lite.git
+Project-URL: Issues, https://github.com/EulogySnowfall/SurrealDB-ORM-lite/issues
+Project-URL: Changelog, https://github.com/EulogySnowfall/SurrealDB-ORM-lite/blob/main/CHANGELOG.md
 Author-email: Yannick Croteau <croteau.yannick@gmail.com>
 License: # MIT License
         

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "surreal-orm-lite"
-version = "0.2.0"
+version = "0.2.2"
 description = "Lightweight Django-style ORM for SurrealDB using the official Python SDK. Async support with Pydantic validation."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -30,11 +30,11 @@ dependencies = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/EulogySnowfall/surreal-orm-lite"
-Documentation = "https://github.com/EulogySnowfall/surreal-orm-lite"
-Repository = "https://github.com/EulogySnowfall/surreal-orm-lite.git"
-Issues = "https://github.com/EulogySnowfall/surreal-orm-lite/issues"
-Changelog = "https://github.com/EulogySnowfall/surreal-orm-lite/blob/main/CHANGELOG.md"
+Homepage = "https://github.com/EulogySnowfall/SurrealDB-ORM-lite"
+Documentation = "https://github.com/EulogySnowfall/SurrealDB-ORM-lite"
+Repository = "https://github.com/EulogySnowfall/SurrealDB-ORM-lite.git"
+Issues = "https://github.com/EulogySnowfall/SurrealDB-ORM-lite/issues"
+Changelog = "https://github.com/EulogySnowfall/SurrealDB-ORM-lite/blob/main/CHANGELOG.md"
 
 [tool.setuptools]
 packages = ["src/surreal_orm_lite"]

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/src/surreal_orm_lite/__init__.py

@@ -1,3 +1,5 @@
+__version__ = "0.2.2"
+
 from .connection_manager import SurrealDBConnectionManager
 from .enum import OrderBy
 from .exceptions import (
@@ -11,6 +13,7 @@ from .model_base import BaseSurrealModel, SurrealConfigDict
 from .query_set import QuerySet
 
 __all__ = [
+    "__version__",
     "SurrealDBConnectionManager",
     "BaseSurrealModel",
     "QuerySet",

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/src/surreal_orm_lite/connection_manager.py

@@ -39,9 +39,7 @@ class SurrealDBConnectionManager:
     @classmethod
     async def unset_connection(cls) -> None:
         """
-        Set the connection kwargs for the SurrealDB instance.
-
-        :param kwargs: The connection kwargs for the SurrealDB instance.
+        Clear all connection settings and close the connection.
         """
         cls.__url = None
         cls.__user = None
@@ -80,7 +78,7 @@ class SurrealDBConnectionManager:
         assert cls.__user is not None
         assert cls.__password is not None
 
-        # Établir la connexion
+        # Establish the connection
         try:
             url = cls.__url
             _client = AsyncSurreal(url)
@@ -107,8 +105,6 @@ class SurrealDBConnectionManager:
         """
         Close the connection to the SurrealDB instance.
         """
-        # Fermer la connexion
-
         if cls.__client is None:
             return
 
@@ -121,9 +117,7 @@ class SurrealDBConnectionManager:
         """
         Reconnect to the SurrealDB instance.
         """
-        # Fermer la connexion
         await cls.close_connection()
-        # Établir la connexion
         return await cls.get_client()
 
     @classmethod
@@ -133,7 +127,6 @@ class SurrealDBConnectionManager:
 
         :return: True if the connection is valid, False otherwise.
         """
-        # Valider la connexion
         try:
             await cls.reconnect()
             return True
@@ -296,9 +289,9 @@ class SurrealDBConnectionManager:
     @classmethod
     def is_password_set(cls) -> bool:
         """
-        Get the database to use.
+        Check if the password is set.
 
-        :return: The database to use.
+        :return: True if the password is set, False otherwise.
         """
         return cls.__password is not None
 

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/src/surreal_orm_lite/exceptions.py

@@ -44,11 +44,12 @@ class SurrealDbValidationError(SurrealORMError):
     pass
 
 
-class SurrealDbNotFoundError(SurrealORMError):
+class SurrealDbNotFoundError(SurrealDbError):
     """
     Not found error.
 
     Raised when a requested record or resource is not found.
+    Inherits from SurrealDbError for backward compatibility.
     """
 
     pass

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/src/surreal_orm_lite/model_base.py

@@ -76,12 +76,12 @@ class BaseSurrealModel(BaseModel):
     @classmethod
     def set_data(cls, data: Any) -> Any:
         """
-        Set the ID of the model instance.
+        Pre-process data before model validation.
+        Extracts the ID from RecordID if present.
         """
-        if isinstance(data, dict):  # pragma: no cover
-            if "id" in data and isinstance(data["id"], RecordID):
-                data["id"] = str(data["id"]).split(":")[1]
-            return data
+        if isinstance(data, dict) and "id" in data and isinstance(data["id"], RecordID):
+            data["id"] = str(data["id"]).split(":")[1]
+        return data
 
     async def refresh(self) -> None:
         """
@@ -96,8 +96,19 @@ class BaseSurrealModel(BaseModel):
         if record is None:
             raise SurrealDbError("Can't refresh data, no record found.")  # pragma: no cover
 
-        self.from_db(record)
-        return None
+        # SDK 1.0.8 returns a list even for single record select
+        if isinstance(record, list):
+            if len(record) == 0:
+                raise SurrealDbError("Can't refresh data, no record found.")  # pragma: no cover
+            record = record[0]
+
+        # Update current instance with refreshed data
+        if isinstance(record, dict):
+            for key, value in record.items():
+                if key == "id" and isinstance(value, RecordID):
+                    value = str(value).split(":")[1]
+                if hasattr(self, key):
+                    object.__setattr__(self, key, value)
 
     async def save(self) -> Self:
         """
@@ -131,9 +142,13 @@ class BaseSurrealModel(BaseModel):
         if record is None:
             raise SurrealDbError("Can't save data, no record returned.")  # pragma: no cover
 
-        obj = self.from_db(record)
-        if isinstance(obj, type(self)):
-            self = obj
+        # Update current instance with the auto-generated ID
+        if isinstance(record, dict):
+            for key, value in record.items():
+                if key == "id" and isinstance(value, RecordID):
+                    value = str(value).split(":")[1]
+                if hasattr(self, key):
+                    object.__setattr__(self, key, value)
             return self
 
         raise SurrealDbError("Can't save data, no record returned.")  # pragma: no cover
@@ -148,8 +163,8 @@ class BaseSurrealModel(BaseModel):
         id = self.get_id()
         if id is not None:
             thing = f"{self.__class__.__name__}:{id}"
-            test = await client.update(thing, data)
-            return test
+            result = await client.update(thing, data)
+            return result
         raise SurrealDbError("Can't update data, no id found.")
 
     async def merge(self, **data: Any) -> Any:
@@ -187,7 +202,6 @@ class BaseSurrealModel(BaseModel):
             raise SurrealDbError(f"Can't delete Record id -> '{id}' not found!")
 
         logger.info(f"Record deleted -> {deleted}.")
-        del self
 
     @model_validator(mode="after")
     def check_config(self) -> Self:
@@ -197,7 +211,7 @@ class BaseSurrealModel(BaseModel):
 
         if not self.get_index_primary_key() and not hasattr(self, "id"):
             raise SurrealDbError(  # pragma: no cover
-                "Can't create model, the model need either 'id' field or primirary_key in 'model_config'."
+                "Can't create model, the model needs either 'id' field or primary_key in 'model_config'."
             )
 
         return self

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/src/surreal_orm_lite/query_set.py

@@ -6,7 +6,7 @@ from pydantic_core import ValidationError
 from . import BaseSurrealModel, SurrealDBConnectionManager
 from .constants import LOOKUP_OPERATORS
 from .enum import OrderBy
-from .exceptions import SurrealDbError
+from .exceptions import SurrealDbError, SurrealDbNotFoundError
 from .utils import remove_quotes_for_variables
 
 logger = logging.getLogger(__name__)
@@ -261,6 +261,10 @@ class QuerySet:
         if where_clauses:
             query += " WHERE " + " AND ".join(where_clauses)
 
+        # Append ORDER BY if set (must come before LIMIT/START in SurrealDB)
+        if self._order_by:
+            query += f" ORDER BY {self._order_by}"
+
         # Append LIMIT if set
         if self._limit is not None:
             query += f" LIMIT {self._limit}"
@@ -269,10 +273,6 @@ class QuerySet:
         if self._offset is not None:
             query += f" START {self._offset}"
 
-        # Append ORDER BY if set
-        if self._order_by:
-            query += f" ORDER BY {self._order_by}"
-
         query += ";"
         return query
 
@@ -333,7 +333,7 @@ class QuerySet:
         if results:
             return results[0]
 
-        raise SurrealDbError("No result found.")
+        raise SurrealDbNotFoundError("No result found.")
 
     async def get(self, id_item: Any = None) -> Any:
         """
@@ -363,7 +363,7 @@ class QuerySet:
             # SDK 1.0.8 returns a list even for single record select
             if isinstance(data, list):
                 if len(data) == 0:
-                    raise SurrealDbError("No result found.")
+                    raise SurrealDbNotFoundError("No result found.")
                 data = data[0]
             return self.model.from_db(data)
         else:
@@ -372,7 +372,7 @@ class QuerySet:
                 raise SurrealDbError("More than one result found.")
 
             if len(result) == 0:
-                raise SurrealDbError("No result found.")
+                raise SurrealDbNotFoundError("No result found.")
             return result[0]
 
     async def all(self) -> Any:

{surreal_orm_lite-0.2.0 → surreal_orm_lite-0.2.2}/src/surreal_orm_lite/utils.py

@@ -2,5 +2,5 @@ import re
 
 
 def remove_quotes_for_variables(query: str) -> str:
-    # Regex for remove single cote on variables ($)
+    # Regex to remove single quotes around variables ($)
     return re.sub(r"'(\$[a-zA-Z_]\w*)'", r"\1", query)