[O] Separate normalize_directory function

src/utils.py

@@ -0,0 +1,110 @@
+import dataclasses
+import json
+import os
+from dataclasses import dataclass
+from datetime import datetime, date
+from typing import Union
+
+import json5
+
+
+@dataclass
+class Config:
+    # Twitter's official API v1 keys
+    consumer_key: str
+    consumer_secret: str
+    access_token: str
+    access_secret: str
+
+    # Twitter's Web API keys
+    # Twitter web authentication token, you can get this by inspecting XHR requests
+    twitter_web_bearer: str
+    # Twitter web cookies file path, you can export cookies using EditThisCookie plugin
+    twitter_web_cookies: str
+    # Twitter request rate: How many requests per second
+    twitter_rate_limit: int
+
+    # Telegram config
+    # Telegram bot token
+    telegram_token: str
+    # Telegram update user id (Who should the bot send updates to?)
+    telegram_userid: int
+
+
+def load_config(path: str = 'config.json5') -> Config:
+    """
+    Load config using JSON5, from either the local file ~/config.json5 or from the environment variable named config.
+
+    :param path: Path of the config file (Default: config.json5)
+    :return: Config object
+    """
+    if os.path.isfile(path):
+        with open(path, 'r', encoding='utf-8') as f:
+            conf = json5.load(f)
+    else:
+        conf = json5.loads(os.getenv('config'))
+
+    return Config(**conf)
+
+
+def debug(msg: object) -> None:
+    """
+    Output a debug message
+
+    :param msg: Message
+    """
+    print('[DEBUG] ' + str(msg))
+
+
+def normalize_directory(directory: str) -> str:
+    """
+    Normalize a directory input: Ensure that the directory doesn't end with "/", and ensure that an
+    empty directory input will be relative (".")
+
+    >>> normalize_directory('')
+    '.'
+    >>> normalize_directory('path/')
+    'path'
+    >>> normalize_directory('path')
+    'path'
+
+    :param directory: Input directory
+    :return: Normalized directory
+    """
+    if directory == '':
+        directory = '.'
+    if directory.endswith('/'):
+        directory = directory[:-1]
+    return directory
+
+
+class EnhancedJSONEncoder(json.JSONEncoder):
+    def default(self, o):
+
+        # Support encoding dataclasses
+        # https://stackoverflow.com/a/51286749/7346633
+        if dataclasses.is_dataclass(o):
+            return dataclasses.asdict(o)
+
+        # Support encoding datetime
+        if isinstance(o, (datetime, date)):
+            return o.isoformat()
+
+        # Support for sets
+        # https://stackoverflow.com/a/8230505/7346633
+        if isinstance(o, set):
+            return list(o)
+
+        return super().default(o)
+
+
+def json_stringify(obj, indent: Union[int, None] = 1) -> str:
+    """
+    Serialize json string with support for dataclasses and datetime and sets and with custom
+    configuration.
+
+    :param obj: Objects
+    :param indent: Indent size or none
+    :return: Json strings
+    """
+    return json.dumps(obj, indent=indent, cls=EnhancedJSONEncoder, ensure_ascii=False)