scruby 2.3.0__py3-none-any.whl → 2.3.2__py3-none-any.whl

scruby/cache.py

@@ -67,7 +67,7 @@ class DocCache:
         for subclass in subclasses:
             collection_name: str = subclass.__name__
 
-            # Create metadata for collection
+            # Create metadata for the collection if it is missing
             Metadata.create(collection_name)
 
             if HASH_REDUCE_LEFT == 0:

scruby/config.py

@@ -27,7 +27,7 @@ import sys
 from typing import Any, ClassVar, Literal, Never, assert_never, final
 from uuid import uuid4
 
-from scruby.utils import add_to_env, get_from_env
+from scruby.utils import Utils
 
 
 @final
@@ -77,10 +77,10 @@ class ScrubyConfig:
         delimiter: str = "/" if cls.sys_platform != "win32" else ""
         dotenv_path: str = f"{cls.db_root}{delimiter}.env.meta"
 
-        db_id: str | None = get_from_env(
+        db_id: str | None = Utils.get_from_env(
             key=key,
             dotenv_path=dotenv_path,
-        ) or add_to_env(
+        ) or Utils.add_to_env(
             key=key,
             value=str(uuid4())[:8],
             dotenv_path=dotenv_path,
@@ -116,10 +116,10 @@ class ScrubyConfig:
         delimiter: str = "/" if cls.sys_platform != "win32" else ""
         dotenv_path: str = f"{cls.db_root}{delimiter}.env.meta"
 
-        hash_reduce_left: str | None = get_from_env(
+        hash_reduce_left: str | None = Utils.get_from_env(
             key=key,
             dotenv_path=dotenv_path,
-        ) or add_to_env(
+        ) or Utils.add_to_env(
             key=key,
             value=str(cls.HASH_REDUCE_LEFT),
             dotenv_path=dotenv_path,

scruby/db.py

@@ -40,12 +40,13 @@ class Scruby(
         self,
         class_model: Any,
     ) -> None:
-        assert ScrubyModel in class_model.__bases__, (
-            "Scruby => Argument `class_model` does not contain the base class `ScrubyModel`."
-        )
-        assert "key" in list(class_model.model_fields.keys()), (
-            f"Model: {class_model.__name__} => The `key` field is missing."
-        )
+        if __debug__:
+            if ScrubyModel not in class_model.__bases__:
+                msg = "Scruby => Argument `class_model` does not contain the base class `ScrubyModel`."
+                raise AssertionError(msg)
+            if "key" not in list(class_model.model_fields.keys()):
+                msg = f"Model: {class_model.__name__} => The `key` field is missing."
+                raise AssertionError(msg)
 
         super().__init__()
         self._class_model = class_model
@@ -191,11 +192,15 @@ class Scruby(
         Returns:
             None.
         """
-        if __debug__ and plugins is not None:
-            for plugin in plugins:
-                if plugin.SCRUBY_VERSION != 2:
-                    msg = f"Plugin {plugin.__name__} does not apply to version 2."
-                    raise AssertionError(msg)
+        subclasses: list[Any] = ScrubyModel.__subclasses__()
+        if __debug__:
+            if len(subclasses) == 0:
+                raise AssertionError("Create least one model of document for your project.")
+            if plugins is not None:
+                for plugin in plugins:
+                    if plugin.SCRUBY_VERSION != 2:
+                        msg = f"Plugin {plugin.__name__} does not apply to version 2."
+                        raise AssertionError(msg)
 
         ScrubyConfig.db_root = db_root
         ScrubyConfig.HASH_REDUCE_LEFT = hash_reduce_left
@@ -203,4 +208,4 @@ class Scruby(
         ScrubyConfig.plugins = plugins
         ScrubyConfig.init_params()
         ScrubyConfig.check_hash_reduce_left()
-        DocCache.load_cache(ScrubyModel.__subclasses__())
+        DocCache.load_cache(subclasses)

scruby/utils.py

@@ -2,10 +2,7 @@
 
 from __future__ import annotations
 
-__all__ = (
-    "get_from_env",
-    "add_to_env",
-)
+__all__ = ("Utils",)
 
 
 from pathlib import Path
@@ -13,59 +10,68 @@ from pathlib import Path
 from dotenv import dotenv_values
 
 
-def get_from_env(
-    key: str,
-    dotenv_path: Path | str = ".env",
-) -> str | None:
-    """Get value by key from .env file.
-
-    Returns:
-        None
-    """
-    assert len(key) > 0, "`get_from_env` => `key` must not be the empty string."
-
-    value: str | None = None
-
-    if isinstance(dotenv_path, str):
-        dotenv_path = Path(dotenv_path)
-
-    if dotenv_path.exists():
-        env_dict: dict[str, str | None] = dotenv_values(dotenv_path)
-        value = env_dict.get(key)
-
-    return value
-
-
-def add_to_env(
-    key: str,
-    value: str,
-    dotenv_path: Path | str = ".env",
-) -> str | None:
-    """Add key-value to .env file.
-
-    Returns:
-        `value` or None
-    """
-    assert len(key) > 0, "`add_to_env` => `key` must not be the empty string."
-    assert len(value) > 0, "`add_to_env` => `value` must not be the empty string."
-
-    if isinstance(dotenv_path, str):
-        assert len(dotenv_path) > 0, "`add_to_env` => `dotenv_path` must not be the empty string."
-        dotenv_path = Path(dotenv_path)
-
-    if dotenv_path.exists():
-        env_dict: dict[str, str | None] = dotenv_values(dotenv_path)
-        saved_value = env_dict.get(key)
-        if saved_value is None:
-            with dotenv_path.open("a+", encoding="utf-8") as env_file:
-                content = f"\n{key}={value}"
-                env_file.write(content)
+class Utils:
+    """Set of helper methods."""
+
+    @staticmethod
+    def get_from_env(
+        key: str,
+        dotenv_path: Path | str = ".env",
+    ) -> str | None:
+        """Get value by key from .env file."""
+        assert len(key) > 0, "`get_from_env` => `key` must not be the empty string."
+
+        value: str | None = None
+
+        if isinstance(dotenv_path, str):
+            dotenv_path = Path(dotenv_path)
+
+        if dotenv_path.exists():
+            env_dict: dict[str, str | None] = dotenv_values(dotenv_path)
+            value = env_dict.get(key)
+
+        return value
+
+    @staticmethod
+    def add_to_env(
+        key: str,
+        value: str,
+        dotenv_path: Path | str = ".env",
+    ) -> str | None:
+        """Add key-value to .env file."""
+        assert len(key) > 0, "`add_to_env` => `key` must not be the empty string."
+        assert len(value) > 0, "`add_to_env` => `value` must not be the empty string."
+
+        if isinstance(dotenv_path, str):
+            assert len(dotenv_path) > 0, "`add_to_env` => `dotenv_path` must not be the empty string."
+            dotenv_path = Path(dotenv_path)
+
+        if dotenv_path.exists():
+            env_dict: dict[str, str | None] = dotenv_values(dotenv_path)
+            saved_value = env_dict.get(key)
+            if saved_value is None:
+                with dotenv_path.open("a+", encoding="utf-8") as env_file:
+                    content = f"\n{key}={value}"
+                    env_file.write(content)
+            else:
+                raise KeyError(f"`add_to_env` => Key `{key}` already exists.")
         else:
-            raise KeyError(f"`add_to_env` => Key `{key}` already exists.")
-    else:
-        target_dir: str = "/".join(str(dotenv_path).split("/")[:-1])
-        Path(target_dir).mkdir(parents=True, exist_ok=True)
-        content = f"{key}={value}"
-        dotenv_path.write_text(data=content, encoding="utf-8")
-
-    return value
+            target_dir: str = "/".join(str(dotenv_path).split("/")[:-1])
+            Path(target_dir).mkdir(parents=True, exist_ok=True)
+            content = f"{key}={value}"
+            dotenv_path.write_text(data=content, encoding="utf-8")
+
+        return value
+
+    @staticmethod
+    def db_collection_list(db_root: Path | str) -> list[str] | None:
+        """Get a list of collections from a database directory."""
+        if isinstance(db_root, str):
+            assert len(db_root) > 0, "`add_to_env` => `dotenv_path` must not be the empty string."
+            db_root = Path(db_root)
+
+        directory_names: list[str] | None = None
+        if db_root.exists():
+            all_entries = Path.iterdir(db_root)
+            directory_names = [entry.name for entry in all_entries if entry.name != ".env.meta"] or None
+        return directory_names

{scruby-2.3.0.dist-info → scruby-2.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 2.3.0
+Version: 2.3.2
 Summary: Asynchronous library for building and managing a hybrid database, by scheme of key-value.
 Project-URL: Bug Tracker, https://github.com/kebasyaty/scruby/issues
 Project-URL: Changelog, https://github.com/kebasyaty/scruby/blob/v2/CHANGELOG.md
@@ -90,13 +90,13 @@ Description-Content-Type: text/markdown
 <p>
 <b>Parameter `ScrubyConfig.HASH_REDUCE_LEFT - Scruby.run(hash_reduce_left = 7)`:</b>
 <br>
-7 = 16 branches in collection (is default) -> ~16000+ docs, RAM ~2G+ (for development).
+7 = 16 branches in collection (is default) -> Docs: ~16000+, RAM: ~2G+, CPU: ~2G+ (for development).
 <br>
-6 = 256 branches in collection -> ~256000+ docs, RAM ~4G+ (for small projects).
+6 = 256 branches in collection -> Docs: ~256000+, RAM: ~4G+, CPU: ~2G+ (for small projects).
 <br>
-5 = 4096 branches in collection -> ~4096000+ docs, RAM ~6G+ (for large projects).
+5 = 4096 branches in collection -> Docs: ~4096000+, RAM: ~6G+, CPU: ~3G+ (for large projects).
 <br>
-0 = 4294967296 branches in collection -> ~4,294967296×10¹²+ docs, RAM ~2G+ (access only by keys).
+0 = 4294967296 branches in collection -> Docs: ~4,294967296×10¹²+, RAM: ~2G+, CPU: ~2G+ (access only by keys).
 <br>
 <br>
 <b>If you notice the production server slowing down,</b><br>

{scruby-2.3.0.dist-info → scruby-2.3.2.dist-info}/RECORD

@@ -1,13 +1,13 @@
 scruby/__init__.py,sha256=YIR8zFx0GmS8ha96-MU9yCgKeYNIh1K8idlQckfg21E,1324
 scruby/aggregation.py,sha256=NBFxQqyRqUG2KIuD9fbl4uzSHJWTaskjiZ1YNBa-Zbo,3575
-scruby/cache.py,sha256=wGnjuFlpA3sRGfp4vv3o3nXR_tOC8HtuzFv1TyrKEyk,3997
-scruby/config.py,sha256=INAFqNAeF8BifIywjElC97rawfTLuqpRfieUdAO7A6k,5122
-scruby/db.py,sha256=3erS6kDcjNy6KBx_8x58P6lI_2DzaIkYg3DK5_NQ_iY,6796
+scruby/cache.py,sha256=j_uRBF72p7kzUK6GMHIIqb8nM2RneCod45dbbI1KTjQ,4018
+scruby/config.py,sha256=oyBEOzmKy9vka23ZDvP8Jqu-HMYn8HCmJ0j2TfOs-0w,5127
+scruby/db.py,sha256=oulRx20bezbv2IwcsDq6TgsXo_zQz8ZE6ohmWg4kv2k,7107
 scruby/errors.py,sha256=lTWiHzyO5Es9Nkf7quODJjONGn6ifcL95qlpA4epQQM,1386
 scruby/meta.py,sha256=dfr8q3TWhVcEl-lZuH5yd9rbO9vAPBhXBO3VYCNcOWo,1283
 scruby/model.py,sha256=1infUd1G-zxj5Z93mNOp1Wi2anD6TKDgu5Y0KEVcH2k,292
 scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby/utils.py,sha256=ZwWxSyh_BAOQkXlIqXFOlX2lHVk9rfYGQiVqtTk8PpE,1865
+scruby/utils.py,sha256=fCBBrp-tgRKh4bukjWRUQhkOsNCxGN4lbXcymBqCsbE,2587
 scruby/mixins/__init__.py,sha256=nT79e80zXliuTGhR9CFosI2-3PQUCKwXbR7wPiFwgrU,669
 scruby/mixins/collection.py,sha256=3Gn9zIT-WnSCBd-IgpE9tobRlW675YX__qaWoUOWIJM,1758
 scruby/mixins/count.py,sha256=CGpyOpsG25uC5utI2ByNxq2iTbJocj6w5tXrC1_cP40,2561
@@ -16,8 +16,8 @@ scruby/mixins/delete.py,sha256=InKVIud_ZYx9-CchUz_IygQDXMynNi4jQ0HKYeHC_R8,4328
 scruby/mixins/find.py,sha256=oEZRE6RqIBdwvNr8iSYyod8hI6ibi_egJP0pyXmJiss,9169
 scruby/mixins/keys.py,sha256=MvBy_8fQGROaQATK2qse2V8wR-xodPQG0KKZ2PK_t9U,10790
 scruby/mixins/update.py,sha256=TyxvxB-gNijlfzTmhwrq0ydvu0C3R-RihW5h5tJ96bM,4964
-scruby-2.3.0.dist-info/METADATA,sha256=mtGCSIcs5Ah_xokLG3OnmnjDJGeDGBSFp0iNNT8DxUk,13382
-scruby-2.3.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-scruby-2.3.0.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-scruby-2.3.0.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
-scruby-2.3.0.dist-info/RECORD,,
+scruby-2.3.2.dist-info/METADATA,sha256=MdIGXw69UNrbUb6I-2lecMGvekaPun_-Bf9ksHkV0us,13434
+scruby-2.3.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+scruby-2.3.2.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+scruby-2.3.2.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
+scruby-2.3.2.dist-info/RECORD,,