tinydantic 0.3.0__tar.gz → 0.3.1__tar.gz

{tinydantic-0.3.0 → tinydantic-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinydantic
-Version: 0.3.0
+Version: 0.3.1
 Summary: A Pydantic-powered ODM (object-document mapper) for TinyDB
 Keywords: odm,pydantic,tinydb
 Author: Chris Wilson

{tinydantic-0.3.0 → tinydantic-0.3.1}/pyproject.toml

@@ -50,7 +50,7 @@ license-files = [
 name = "tinydantic"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "0.3.0"
+version = "0.3.1"
 
 [project.urls]
 Changelog = "https://github.com/tinydantic/tinydantic/blob/main/CHANGELOG.md"
@@ -219,7 +219,7 @@ verbose = 2
 python_version = "3.10"
 
 [tool.pytest.ini_options]
-addopts = "--doctest-modules --doctest-glob '*.md' --ignore=docs/superpowers"
+addopts = "--doctest-modules --doctest-glob '*.md'"
 doctest_optionflags = "NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL"
 filterwarnings = [
   # The queries.md "shadowing" section deliberately defines a field named

{tinydantic-0.3.0 → tinydantic-0.3.1}/src/tinydantic/__init__.py

@@ -2,12 +2,15 @@
 #
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 
-"""`tinydantic` is a simple Python object-document mapper (ODM) for the
-[TinyDB](https://tinydb.readthedocs.io/en/latest/) document database.
+"""A simple Python object-document mapper (ODM) for TinyDB.
+
+`tinydantic` maps Python objects to and from documents stored in
+the [TinyDB](https://tinydb.readthedocs.io/en/latest/) document
+database.
 
 Attributes:
     __version__: The `tinydantic` package version.
-"""  # noqa: D205
+"""
 
 from importlib import metadata
 

{tinydantic-0.3.0 → tinydantic-0.3.1}/src/tinydantic/_errors.py

@@ -64,7 +64,7 @@ class DocumentNotFoundError(TinydanticError):
     """Requested document is not found."""
 
     def __init__(self) -> None:
-        """Initializes an instance of this class."""
+        """Initialize with the "Document not found" message."""
         super().__init__("Document not found")
 
 
@@ -72,5 +72,5 @@ class DocumentIDRequiredError(TinydanticError):
     """Required document ID is missing."""
 
     def __init__(self) -> None:
-        """Initializes an instance of this class."""
+        """Initialize with the "Document ID is required" message."""
         super().__init__("Document ID is required")

{tinydantic-0.3.0 → tinydantic-0.3.1}/src/tinydantic/tinydb/storages.py

@@ -31,7 +31,7 @@ class YAMLStorage(Storage):
         create_dirs: bool = False,
         encoding: str | None = None,
         access_mode: str = "r+",
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         """Create a new instance.
 
@@ -41,9 +41,14 @@ class YAMLStorage(Storage):
         Note: Using an access mode other than `r` or `r+` will probably
         lead to data loss or data corruption!
 
-        :param path: Where to store the YAML data.
-        :param access_mode: mode in which the file is opened (r, r+)
-        :type access_mode: str
+        Args:
+            path: Where to store the YAML data.
+            create_dirs: Whether to create all missing parent
+                directories of the storage file.
+            encoding: The encoding used to open the storage file.
+            access_mode: Mode in which the file is opened (`r`, `r+`).
+            **kwargs: Additional keyword arguments passed to
+                `yaml.dump()` when writing data.
         """
         super().__init__()
 
@@ -74,9 +79,9 @@ class YAMLStorage(Storage):
     def read(self) -> dict[str, dict[str, Any]] | None:
         """Read data from storage.
 
-        :return: A python dict containing the database data from
-            storage.
-        :rtype: dict[str, dict[str, Any]] | None
+        Returns:
+            A python dict containing the database data from storage,
+            or `None` if the storage file is empty.
         """
         # Get the file size by moving the cursor to the file end and
         # reading its location