refactor: name convention remove DTO, Model

check-phat-nguoi · Jan 9, 2025 · 6e39112 · 6e39112
1 parent 76fcba9
commit 6e39112
Show file tree

Hide file tree

Showing 40 changed files with 364 additions and 310 deletions.
diff --git a/config.sample.json b/config.sample.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/KevinNitroG/check-phat-nguoi/refs/heads/main/docs/schemas/config.json",
+  "$schema": "https://raw.githubusercontent.com/KevinNitroG/check-phat-nguoi/refs/heads/main/schemas/config.json",
   "plates": [
     {
       "plate": "59XA00000",

diff --git a/schemas/config.json b/schemas/config.json
@@ -9,7 +9,7 @@
       "title": "ApiEnum",
       "type": "string"
     },
-    "PlateInfoDTO": {
+    "PlateInfo": {
       "properties": {
         "plate": {
           "description": "Biển số",
@@ -74,10 +74,10 @@
         "plate",
         "type"
       ],
-      "title": "PlateInfoDTO",
+      "title": "Thông tin thiết lập cho biển số",
       "type": "object"
     },
-    "TelegramNotificationDTO": {
+    "TelegramNotificationConfig": {
       "properties": {
         "enabled": {
           "default": true,
@@ -86,17 +86,17 @@
           "type": "boolean"
         },
         "telegram": {
-          "$ref": "#/$defs/TelegramNotificationEngineDTO",
-          "description": "Gửi thông báo đến telegram"
+          "$ref": "#/$defs/TelegramNotificationEngineConfig",
+          "description": "Telegram"
         }
       },
       "required": [
         "telegram"
       ],
-      "title": "TelegramNotificationDTO",
+      "title": "Telegram và kích hoạt",
       "type": "object"
     },
-    "TelegramNotificationEngineDTO": {
+    "TelegramNotificationEngineConfig": {
       "properties": {
         "botToken": {
           "description": "Bot token Telegram",
@@ -119,7 +119,7 @@
         "botToken",
         "chatId"
       ],
-      "title": "TelegramNotificationEngineDTO",
+      "title": "Telegram",
       "type": "object"
     },
     "VehicleTypeEnum": {
@@ -136,18 +136,26 @@
     "plates": {
       "description": "Danh sách các biển xe",
       "items": {
-        "$ref": "#/$defs/PlateInfoDTO"
+        "$ref": "#/$defs/PlateInfo"
       },
-      "title": "Plates",
+      "title": "Danh sách biển xe",
       "type": "array"
     },
     "notifications": {
+      "anyOf": [
+        {
+          "items": {
+            "$ref": "#/$defs/TelegramNotificationConfig"
+          },
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
       "description": "Danh sách các thiết lập để thông báo",
-      "items": {
-        "$ref": "#/$defs/TelegramNotificationDTO"
-      },
-      "title": "Notifications",
-      "type": "array"
+      "title": "Danh sách thông báo"
     },
     "api": {
       "$ref": "#/$defs/ApiEnum",
@@ -157,29 +165,38 @@
     },
     "unpaidOnly": {
       "default": true,
-      "description": "Chỉ hiển thị thông tin vi phạm chưa nộp phạt",
-      "title": "Unpaidonly",
+      "description": "Chỉ lọc các thông tin vi phạm chưa nộp phạt",
+      "title": "Lọc chưa nộp phạt",
       "type": "boolean"
     },
     "verbose": {
       "default": false,
       "description": "Hiển thị tất cả thông tin có thể hiển thị",
-      "title": "Verbose",
+      "title": "Hiển thị đầy đủ thông tin",
       "type": "boolean"
     },
     "requestTimeout": {
       "default": 10,
       "description": "Thời gian (s) để gửi request đến server API và gửi notify message",
-      "title": "Requesttimeout",
+      "title": "Thời gian request",
+      "type": "integer"
+    },
+    "requestPerTime": {
+      "default": 5,
+      "description": "Số lượng request tối chạy song song",
+      "exclusiveMinimum": 0,
+      "title": "Số lượng request",
       "type": "integer"
     },
     "detailLog": {
-      "default": true,
-      "title": "Detaillog",
+      "default": false,
+      "description": "Log chi tiết",
+      "title": "Log chi tiết",
       "type": "boolean"
     },
     "logLevel": {
       "default": "WARNING",
+      "description": "Mức độ log",
       "enum": [
         "NOTSET",
         "DEBUG",
@@ -188,14 +205,13 @@
         "ERROR",
         "CRITICAL"
       ],
-      "title": "Loglevel",
+      "title": "Mức độ log",
       "type": "string"
     }
   },
   "required": [
-    "plates",
-    "notifications"
+    "plates"
   ],
-  "title": "ConfigDTO",
+  "title": "Config",
   "type": "object"
 }
diff --git a/src/check_phat_nguoi/__init__.py b/src/check_phat_nguoi/__init__.py
@@ -1,3 +1,6 @@
-from .config import ConfigDTO
+from check_phat_nguoi.get_data import GetData
+from check_phat_nguoi.notify import SendNotifications
 
-__all__ = ["ConfigDTO"]
+from .config import Config
+
+__all__ = ["Config", "GetData", "SendNotifications"]
diff --git a/src/check_phat_nguoi/__main__.py b/src/check_phat_nguoi/__main__.py
@@ -3,9 +3,8 @@
 
 from truststore import inject_into_ssl
 
+from check_phat_nguoi import GetData, SendNotifications
 from check_phat_nguoi.config.config_reader import config
-from check_phat_nguoi.get_data import GetData
-from check_phat_nguoi.notify import SendNotifications
 
 from .utils.setup_logger import setup_logger
 

diff --git a/src/check_phat_nguoi/config/__init__.py b/src/check_phat_nguoi/config/__init__.py
@@ -1,21 +1,19 @@
-from .dto import (
-    ApiEnum,
-    BaseNotificationDTO,
-    BaseNotificationEngineDTO,
-    ConfigDTO,
-    PlateInfoDTO,
-    TelegramNotificationDTO,
-    TelegramNotificationEngineDTO,
-)
 from .exceptions import NoConfigFoundException
+from .models import (
+    BaseNotificationConfig,
+    BaseNotificationEngineConfig,
+    Config,
+    PlateInfo,
+    TelegramNotificationConfig,
+    TelegramNotificationEngineConfig,
+)
 
 __all__ = [
-    "ApiEnum",
     "NoConfigFoundException",
-    "BaseNotificationDTO",
-    "BaseNotificationEngineDTO",
-    "ConfigDTO",
-    "PlateInfoDTO",
-    "TelegramNotificationEngineDTO",
-    "TelegramNotificationDTO",
+    "BaseNotificationConfig",
+    "BaseNotificationEngineConfig",
+    "Config",
+    "PlateInfo",
+    "TelegramNotificationEngineConfig",
+    "TelegramNotificationConfig",
 ]
diff --git a/src/check_phat_nguoi/config/config_reader.py b/src/check_phat_nguoi/config/config_reader.py
@@ -6,26 +6,25 @@
 
 from check_phat_nguoi.constants.config import CONFIG_PATHS
 
-from .dto import ConfigDTO
-from .exceptions import NoConfigFoundException
+from .models import Config
 
 
-def _config_reader() -> ConfigDTO:
+def _config_reader() -> Config:
     for config_path in CONFIG_PATHS:
         if path_exists(config_path):
             try:
                 with open(config_path, encoding="utf8") as config:
                     data = load(config)
-                    return ConfigDTO(**data)
+                    return Config(**data)
             except ValidationError as e:
                 print("Failed to read the config!")
                 print(e)
                 exit(1)
+    print("No config was found!")
+    exit(1)
 
-    raise NoConfigFoundException()
 
-
-config: Final[ConfigDTO] = _config_reader()
+config: Final[Config] = _config_reader()
 
 
 __all__ = ["config"]
diff --git a/src/check_phat_nguoi/config/dto/__init__.py b/src/check_phat_nguoi/config/dto/__init__.py
diff --git a/src/check_phat_nguoi/config/dto/config.py b/src/check_phat_nguoi/config/dto/config.py
diff --git a/src/check_phat_nguoi/config/dto/notifications/__init__.py b/src/check_phat_nguoi/config/dto/notifications/__init__.py
diff --git a/src/check_phat_nguoi/config/dto/notifications/base_engine.py b/src/check_phat_nguoi/config/dto/notifications/base_engine.py
diff --git a/src/check_phat_nguoi/config/dto/notifications/base_notification.py b/src/check_phat_nguoi/config/dto/notifications/base_notification.py
diff --git a/src/check_phat_nguoi/config/dto/notifications/telegram_notification.py b/src/check_phat_nguoi/config/dto/notifications/telegram_notification.py
diff --git a/src/check_phat_nguoi/config/models/__init__.py b/src/check_phat_nguoi/config/models/__init__.py
@@ -0,0 +1,17 @@
+from .config import Config
+from .notifications import (
+    BaseNotificationConfig,
+    BaseNotificationEngineConfig,
+    TelegramNotificationConfig,
+    TelegramNotificationEngineConfig,
+)
+from .plate_info import PlateInfo
+
+__all__ = [
+    "BaseNotificationConfig",
+    "BaseNotificationEngineConfig",
+    "Config",
+    "PlateInfo",
+    "TelegramNotificationEngineConfig",
+    "TelegramNotificationConfig",
+]