Add ruff to project

Author: AliRn76

pantherdb/__init__.py

@@ -1,6 +1,6 @@
-from pantherdb.pantherdb import *
+from pantherdb.pantherdb import *  # noqa: F403
 
-__version__ = '1.2.7'
+__version__ = '1.2.8'
 
 
 __all__ = ('__version__', 'PantherDB', 'PantherCollection', 'PantherDocument', 'PantherDBException')

pantherdb/pantherdb.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
-import os.path
+
+from pathlib import Path
+
 import orjson as json
 from cryptography.fernet import Fernet, InvalidToken
 
@@ -15,7 +17,13 @@ class PantherDB:
     __return_dict: bool
     __content: dict
 
-    def __init__(self, db_name: str | None = None, return_dict: bool = False, secret_key: bytes | None = None):
+    def __init__(
+            self,
+            *,
+            db_name: str | None = None,
+            return_dict: bool = False,
+            secret_key: bytes | None = None,
+    ):
         self.__return_dict = return_dict
         self.__secret_key = secret_key
         self.__fernet = Fernet(self.__secret_key) if self.__secret_key else None
@@ -25,8 +33,7 @@ def __init__(self, db_name: str | None = None, return_dict: bool = False, secret
             if not db_name.endswith('pdb'):
                 db_name = f'{db_name}.pdb'
             self.db_name = db_name
-        if not os.path.exists(self.db_name):
-            open(self.db_name, 'w').close()
+        Path(self.db_name).touch(exist_ok=True)
 
     def __str__(self) -> str:
         self._refresh()
@@ -79,7 +86,7 @@ def collection(self, collection_name: str) -> PantherCollection:
             db_name=self.db_name,
             collection_name=collection_name,
             return_dict=self.return_dict,
-            secret_key=self.secret_key
+            secret_key=self.secret_key,
         )
 
     def close(self):
@@ -89,16 +96,21 @@ def close(self):
 class PantherCollection(PantherDB):
     __collection_name: str
 
-    def __init__(self, db_name: str, collection_name: str, return_dict: bool, secret_key: bytes):
+    def __init__(
+            self,
+            *,
+            db_name: str,
+            collection_name: str,
+            return_dict: bool,
+            secret_key: bytes,
+    ):
         super().__init__(db_name=db_name, return_dict=return_dict, secret_key=secret_key)
         self.__collection_name = collection_name
 
     def __str__(self) -> str:
         self._refresh()
 
-        if self.collection_name not in self.content:
-            result = ''
-        elif documents := self.content[self.collection_name]:
+        if self.collection_name not in self.content or (documents := self.content[self.collection_name]):
             result = ''
         else:
             result = '\n'.join(f'    {k}: {type(v).__name__}' for k, v in documents[0].items())
@@ -122,7 +134,7 @@ def __create_result(self, data: dict, /) -> PantherDocument | dict:
                 collection_name=self.collection_name,
                 return_dict=self.return_dict,
                 secret_key=self.secret_key,
-                **data
+                **data,
             )
 
     def _write_collection(self, documents: list) -> None:
@@ -136,7 +148,7 @@ def _drop_collection(self) -> None:
         self._write()
 
     def _get_collection(self) -> list[dict]:
-        """return documents"""
+        """Return documents"""
         self._refresh()
         return self.content.get(self.collection_name, [])
 
@@ -185,7 +197,7 @@ def delete(self) -> None:
         self.__check_is_panther_document()
         documents = self._get_collection()
         for d in documents:
-            if d.get('_id') == self._id:  # NOQA: Unresolved References
+            if d.get('_id') == self._id:  # noqa: Unresolved References
                 documents.remove(d)
                 self._write_collection(documents)
                 break
@@ -246,7 +258,7 @@ def update(self, **kwargs) -> None:
         self.__check_is_panther_document()
         documents = self._get_collection()
         for d in documents:
-            if d.get('_id') == self._id:  # NOQA: Unresolved References
+            if d.get('_id') == self._id:  # noqa: Unresolved References
                 for k, v in kwargs.items():
                     d[k] = v
                     setattr(self, k, v)
@@ -312,13 +324,21 @@ def drop(self) -> None:
 class PantherDocument(PantherCollection):
     __data: dict
 
-    def __init__(self, db_name: str, collection_name: str, return_dict: bool, secret_key: bytes, **kwargs):
+    def __init__(
+            self,
+            *,
+            db_name: str,
+            collection_name: str,
+            return_dict: bool,
+            secret_key: bytes,
+            **kwargs,
+    ):
         self.__data = kwargs
         super().__init__(
             db_name=db_name,
             collection_name=collection_name,
             return_dict=return_dict,
-            secret_key=secret_key
+            secret_key=secret_key,
         )
 
     def __str__(self) -> str:
@@ -341,7 +361,7 @@ def __setattr__(self, key, value):
             '_PantherDB__content',
             '_PantherDB__fernet',
             '_PantherCollection__collection_name',
-            '_PantherDocument__data'
+            '_PantherDocument__data',
         ]:
             try:
                 object.__getattribute__(self, key)

ruff.toml

@@ -0,0 +1,22 @@
+exclude = [
+    ".venv",
+    "build",
+    ".venv3.8",
+    ".venv312",
+    ".git",
+]
+select = [
+    "ALL"
+]
+ignore = [
+    "C901", "N818", "N805", "D1", "D2", "D400", "D415", "D401", "YTT", "ANN", "S", "B", "C4", "DTZ", "EM", "EXE",
+    "FA", "INP", "PYI024", "PT", "RET503", "RET505", "ARG", "PTH123", "TD", "FIX", "PL", "RUF013", "TRY003", "TRY200"
+]
+
+line-length = 120
+[flake8-quotes]
+inline-quotes = "single"
+
+[per-file-ignores]
+"pantherdb/__init__.py" = ["F405"]
+"pantherdb/pantherdb.py" = ["A003"]

setup.py

@@ -1,16 +1,16 @@
-import os
 import re
 
 from setuptools import setup
 
 
 def pantherdb_version() -> str:
-    with open(os.path.join('pantherdb/__init__.py')) as f:
+    with open('pantherdb/__init__.py') as f:
         return re.search("__version__ = ['\"]([^'\"]+)['\"]", f.read()).group(1)
 
 
 VERSION = pantherdb_version()
-DESCRIPTION = open('README.md').read()
+with open('README.md') as file:
+    DESCRIPTION = file.read()
 
 setup(
     name='pantherdb',

tests/test_normal.py

@@ -1,10 +1,12 @@
-import os
-import orjson as json
 
+from pathlib import Path
+from unittest import TestCase
 from uuid import uuid4
+
+import orjson as json
 from faker import Faker
-from unittest import TestCase
-from pantherdb import PantherDB, PantherCollection, PantherDocument
+
+from pantherdb import PantherCollection, PantherDB, PantherDocument
 
 f = Faker()
 
@@ -19,7 +21,7 @@ def setUp(cls):
 
     @classmethod
     def tearDown(cls):
-        os.remove(cls.db_name)
+        Path(cls.db_name).unlink()
 
     @classmethod
     def create_junk_document(cls, collection) -> int:
@@ -30,20 +32,20 @@ def create_junk_document(cls, collection) -> int:
 
     # Create DB
     def test_creation_of_db(self):
-        self.assertTrue(os.path.exists(self.db_name))
-        self.assertTrue(os.path.isfile(self.db_name))
+        self.assertTrue(Path(self.db_name).exists())
+        self.assertTrue(Path(self.db_name).is_file())
         self.assertEqual(self.db.db_name, self.db_name)
 
     def test_creation_of_db_without_extension(self):
         db_name = uuid4().hex
         db = PantherDB(db_name=db_name)
         final_db_name = f'{db_name}.pdb'
 
-        self.assertTrue(os.path.exists(final_db_name))
-        self.assertTrue(os.path.isfile(final_db_name))
+        self.assertTrue(Path(final_db_name).exists())
+        self.assertTrue(Path(final_db_name).is_file())
         self.assertEqual(db.db_name, final_db_name)
 
-        os.remove(final_db_name)
+        Path(final_db_name).unlink()
 
     def test_creation_of_collection(self):
         collection_name = f.word()
@@ -492,9 +494,6 @@ def test_document_fields(self):
     def test_document_save_method(self):
         collection = self.db.collection(f.word())
 
-        # Add others
-        # _count = self.create_junk_document(collection)
-
         # Insert with specific name
         first_name = f.first_name()
         collection.insert_one(first_name=first_name, last_name=f.last_name())
@@ -537,7 +536,5 @@ def test_document_json_method(self):
         self.assertEqual(obj.json(), json.dumps(_json).decode())
 
 
-# TODO: Test whole scenario with
-#   - secret_key
-#   - return_dict
+# TODO: Test whole scenario with -> secret_key, return_dict
 # TODO: Test where exceptions happen