fix(Client): remove async/await from class

Author: joonas-yoon

src/json_as_db/Client.py renamed to src/json_as_db/Client/BaseClient.py

@@ -1,11 +1,11 @@
 import os
-import json
-import aiofiles
+from abc import ABCMeta, abstractmethod
 
-from .Database import Database
+from typing import Tuple
+from ..Database import Database
 
 
-class Client:
+class BaseClient(metaclass=ABCMeta):
     """
     The Client object contains settings like directory path
     This provides
@@ -25,7 +25,7 @@ def __init__(self, root_dir: str = '.'):
         else:
             os.makedirs(self.root_dir, exist_ok=True)
 
-    def _get_database_path(self, database_name: str) -> tuple:
+    def _get_database_path(self, database_name: str) -> Tuple[str, str]:
         """ returns (file_name, file_path) """
         file_name = f"{database_name}.json"
         file_path = os.path.join(self.root_dir, file_name)
@@ -38,7 +38,21 @@ def _wrapping_database(self, _dict: dict, file_name: str) -> Database:
         database.__name__ = file_name
         return database
 
-    async def create_database(self, database_name: str) -> Database:
+    def _ensure_get_filepath(self, database_name: str, ensure_exists: bool = True) -> str:
+        file_name, file_path = self._get_database_path(database_name)
+
+        exists = os.path.exists(file_path)
+        if ensure_exists != exists:
+            if not exists:
+                raise FileNotFoundError(
+                    f"Not found json file: {file_path}, please create database first.")
+            else:
+                raise FileExistsError(f"Failed to create file on {file_path}")
+
+        return file_path
+
+    @abstractmethod
+    def create_database(self, database_name: str) -> Database:
         """
 
         Args:
@@ -50,18 +64,10 @@ async def create_database(self, database_name: str) -> Database:
         Returns:
             dict: built-in type of dictionary
         """
-        file_name, file_path = self._get_database_path(database_name)
-
-        if os.path.exists(file_path):
-            raise FileExistsError(f"Failed to create file on {file_path}")
-
-        empty_dict = dict()
-        async with aiofiles.open(file_path, mode='w') as f:
-            await f.write(json.dumps(empty_dict))
-
-        return self._wrapping_database(empty_dict, database_name)
+        pass
 
-    async def get_database(self, database_name: str) -> Database:
+    @abstractmethod
+    def get_database(self, database_name: str) -> Database:
         """
 
         Args:
@@ -73,16 +79,7 @@ async def get_database(self, database_name: str) -> Database:
         Returns:
             dict: built-in type of dictionary
         """
-        file_name, file_path = self._get_database_path(database_name)
-
-        if not os.path.exists(file_path):
-            raise FileNotFoundError(
-                f"Not found json file: {file_path}, please create database first.")
-
-        async with aiofiles.open(file_path, mode='r') as f:
-            data = json.loads(await f.read())
-
-        return self._wrapping_database(data, database_name)
+        pass
 
     def remove_database(self, database_name: str) -> None:
         """
@@ -93,10 +90,6 @@ def remove_database(self, database_name: str) -> None:
         Raises:
             FileNotFoundError: when there is no json file to remove
         """
-        file_name, file_path = self._get_database_path(database_name)
-
-        if not os.path.exists(file_path):
-            raise FileNotFoundError(
-                f"Not found json file: {file_path}, please create database first.")
-
+        file_path = self._ensure_get_filepath(database_name, ensure_exists=True)
         os.remove(file_path)
+

src/json_as_db/Client/Client.py

@@ -0,0 +1,42 @@
+import json
+
+from ..Database import Database
+from .BaseClient import BaseClient
+
+
+class Client(BaseClient):
+    """
+    The Client object contains settings like directory path
+    This provides
+    - to create initial JSON file from database name
+    - to read database from JSON file
+    - to remove linked JSON file with database
+
+    Args:
+        dir_path (str): base directory path where file will be in
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def create_database(self, database_name: str) -> Database:
+        file_path = self._ensure_get_filepath(database_name, ensure_exists=False)
+
+        empty_dict = dict()
+        with open(file_path, mode='w') as f:
+            f.write(json.dumps(empty_dict))
+
+        return self._wrapping_database(empty_dict, database_name)
+
+    def get_database(self, database_name: str) -> Database:
+        file_path = self._ensure_get_filepath(database_name, ensure_exists=True)
+
+        with open(file_path, mode='r') as f:
+            data = json.loads(f.read())
+
+        print('get_database::data', data)
+
+        return self._wrapping_database(data, database_name)
+
+    def remove_database(self, database_name: str) -> None:
+        super().remove_database(database_name)

src/json_as_db/Client/__init__.py

@@ -0,0 +1,5 @@
+from .Client import Client
+
+__all__ = [
+    "Client"
+]

src/json_as_db/Database.py

@@ -63,6 +63,7 @@ def __init__(self, *arg, **kwargs):
             'creator': package_name,
             'created_at': now,
             'updated_at': now,
+            # self.__data__: dict(*arg, **kwargs),
             self.__data__: dict(),
         }
         self.__dict__ = _override_only_unset(self.__dict__, defaults)

tests/client/test_methods.py

@@ -1,6 +1,7 @@
 import os
 import json
 import pytest
+import aiofiles
 
 from json_as_db import Client
 from utils import file, logger
@@ -30,9 +31,8 @@ def client() -> Client:
     teardown_client()
 
 
-@pytest.mark.asyncio
-async def test_client_create_empty_database(client: Client):
-    database = await client.create_database('database')
+def test_client_create_empty_database(client: Client):
+    database = client.create_database('database')
     assert isinstance(database, dict)
     path = os.path.join(DB_DIR, 'database.json')
     logger.debug(path)
@@ -43,21 +43,19 @@ async def test_client_create_empty_database(client: Client):
         json.load(f)
 
 
-@pytest.mark.asyncio
-async def test_client_create_database(client: Client):
-    database = await client.create_database('database')
+def test_client_create_database(client: Client):
+    database = client.create_database('database')
     assert isinstance(database, dict)
     path = os.path.join(DB_DIR, 'database.json')
     logger.debug(path)
     assert os.path.exists(path)
 
 
-@pytest.mark.asyncio
-async def test_client_create_database_conflict(client: Client):
+def test_client_create_database_conflict(client: Client):
     path = os.path.join(DB_DIR, 'database.json')
     file.touch(path)
     try:
-        database = await client.create_database('database')
+        database = client.create_database('database')
     except FileExistsError:
         pass
 
@@ -78,13 +76,13 @@ async def test_client_get_database():
       ]
     }
 
-    with open(path, 'r') as f:
-        answer = json.load(f)
+    async with aiofiles.open(path, 'r') as f:
+        answer = json.loads(await f.read())
         logger.debug(answer)
 
     assert expected == answer['data']['jmJKBJBAmGESC3rGbSb62T']
 
-    database = await client.get_database('basic')
+    database = client.get_database('basic')
     logger.debug(expected)
     logger.debug(database)
     assert expected == database['jmJKBJBAmGESC3rGbSb62T']

tests/client/test_usage.py

@@ -19,13 +19,13 @@ def teardown_files(root_dir: str):
         pass
 
 
-@pytest.mark.asyncio
-async def test_basic_usage():
+def test_init_and_remove():
     root_dir = os.path.join(CUR_DIR, file.create_dirpath(prefix='test_usage'))
 
     client = Client(root_dir)
-    database = await client.create_database('my_database')
-    database2 = await client.get_database('my_database')
+    db = client.create_database('my_database')
+    db_get = client.get_database('my_database')
+    assert db == db_get
     client.remove_database('my_database')
 
     teardown_files(root_dir)

tests/database/test_database.py

@@ -249,7 +249,7 @@ async def test_db_save():
     ]
 
     client = Client(temp_dir)
-    db = await client.create_database('db')
+    db = client.create_database('db')
     logger.debug(f'[before saving] {db}')
     db.add(samples)
     logger.debug(f'[after saving] {db}')
@@ -265,7 +265,7 @@ async def test_db_save():
         saved = json.load(f)
         logger.debug(f'[saved] {saved}')
 
-    saved = await client.get_database('db')
+    saved = client.get_database('db')
     assert saved == db
 
     file.remove(temp_dir)