scruby 0.8.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

scruby/db.py

@@ -280,3 +280,11 @@ class Scruby[T]:
                     results.append(doc)
                     counter += 1
         return results or None
+
+    def collection_name(self) -> str:
+        """Get collection name."""
+        return self.__class_model.__name__
+
+    def collection_full_name(self) -> str:
+        """Get full name of collection."""
+        return f"{self.__db_root}/{self.__class_model.__name__}"

{scruby-0.8.1.dist-info → scruby-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.8.1
+Version: 0.9.0
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -288,6 +288,42 @@ if __name__ == "__main__":
     anyio.run(main)
 ```
 
+```python
+"""Get collection name."""
+
+import anyio
+import datetime
+from typing import Annotated
+from pydantic import BaseModel, EmailStr
+from pydantic_extra_types.phone_numbers import PhoneNumber, PhoneNumberValidator
+from scruby import Scruby, constants
+
+constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
+
+class User(BaseModel):
+    """Model of User."""
+    first_name: str
+    last_name: str
+    birthday: datetime.datetime
+    email: EmailStr
+    phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
+
+async def main() -> None:
+    """Example."""
+    # Get collection of `User`.
+    user_coll = Scruby(User)
+
+    print(user_coll.collection_name())  # "User"
+    print(user_coll.collection_full_name())  # "ScrubyDB/User"
+
+    # Full database deletion.
+    # Hint: The main purpose is tests.
+    await Scruby.napalm()
+
+if __name__ == "__main__":
+    anyio.run(main)
+```
+
 ## Changelog
 
 [View the change history](https://github.com/kebasyaty/scruby/blob/v0/CHANGELOG.md "Changelog").

scruby-0.9.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+scruby/__init__.py,sha256=myX7sG-7oAQZGdgfZtTGXYCCraTeuwi7SjBoltftpnM,648
+scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
+scruby/db.py,sha256=1tfDCwoKwUx0a6DfEOpPAV8NYuifmmrX8Q9gU3K6l58,10407
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.9.0.dist-info/METADATA,sha256=7Durmb2_VtJ4plz-OM-vhzfLAM8QGYkmVTRX1KFfOYY,11533
+scruby-0.9.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.9.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.9.0.dist-info/RECORD,,

scruby-0.8.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=myX7sG-7oAQZGdgfZtTGXYCCraTeuwi7SjBoltftpnM,648
-scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
-scruby/db.py,sha256=FWCrcpzP93V1fk7NXhp6x2UgGkwqvk7qXvphm38R0X8,10130
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.8.1.dist-info/METADATA,sha256=TpqA2Ukl-TnolmTr-mRTRIFGE2KcKdzm8tLP1xRWKFM,10632
-scruby-0.8.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.8.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.8.1.dist-info/RECORD,,