potato-util 0.0.5__py3-none-any.whl → 0.2.0__py3-none-any.whl

potato_util/__version__.py

@@ -1 +1 @@
-__version__ = "0.0.5"
+__version__ = "0.2.0"

potato_util/_base.py

@@ -6,6 +6,8 @@ import logging
 
 from pydantic import validate_call
 
+from .validator import is_truthy
+
 
 logger = logging.getLogger(__name__)
 
@@ -78,8 +80,28 @@ def get_slug_name(file_path: str | None = None) -> str:
     return _slug_name
 
 
+def is_debug_mode() -> bool:
+    """Check if the application is running in debug mode based on environment variables.
+
+    Returns:
+        bool: True if in debug mode, False otherwise.
+    """
+
+    _is_debug = False
+    _debug = os.getenv("DEBUG", "").strip().lower()
+    if _debug and is_truthy(_debug):
+        _is_debug = True
+
+    _env = os.getenv("ENV", "").strip().lower()
+    if (_env == "development") and (_debug == ""):
+        _is_debug = True
+
+    return _is_debug
+
+
 __all__ = [
     "deep_merge",
     "camel_to_snake",
     "get_slug_name",
+    "is_debug_mode",
 ]

potato_util/io/_async.py

@@ -1,7 +1,21 @@
+import sys
+import json
 import errno
 import hashlib
 import logging
+import configparser
+from pathlib import Path
+from typing import Any
 
+_binary_toml = False
+if sys.version_info >= (3, 11):
+    import tomllib  # type: ignore
+
+    _binary_toml = True
+else:
+    import toml as tomllib  # type: ignore
+
+import yaml
 import aioshutil
 import aiofiles.os
 from pydantic import validate_call
@@ -276,6 +290,195 @@ async def async_get_file_checksum(
     return _file_checksum
 
 
+@validate_call
+async def async_read_yaml_file(file_path: str | Path) -> dict[str, Any]:
+    """Asynchronous read YAML file.
+
+    Args:
+        file_path (str | Path, required): YAML file path.
+
+    Raises:
+        FileNotFoundError: If YAML file is not found.
+        Exception        : If failed to read YAML file.
+
+    Returns:
+        dict[str, Any]: YAML file data as dictionary.
+    """
+
+    _data: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not await aiofiles.os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' YAML file!")
+
+    try:
+        async with aiofiles.open(file_path, "r", encoding="utf-8") as _file:
+            _content = await _file.read()
+            _data = yaml.safe_load(_content) or {}
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' YAML file!")
+        raise
+
+    return _data
+
+
+@validate_call
+async def async_read_json_file(file_path: str | Path) -> dict[str, Any]:
+    """Asynchronous read JSON file.
+
+    Args:
+        file_path (str | Path, required): JSON file path.
+
+    Raises:
+        FileNotFoundError: If JSON file is not found.
+        Exception        : If failed to read JSON file.
+
+    Returns:
+        dict[str, Any]: JSON file data as dictionary.
+    """
+
+    _data: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not await aiofiles.os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' JSON file!")
+
+    try:
+        async with aiofiles.open(file_path, "r", encoding="utf-8") as _file:
+            _content = await _file.read()
+            _data = json.loads(_content) or {}
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' JSON file!")
+        raise
+
+    return _data
+
+
+@validate_call
+async def async_read_toml_file(file_path: str | Path) -> dict[str, Any]:
+    """Asynchronous read TOML file.
+
+    Args:
+        file_path (str | Path, required): TOML file path.
+
+    Raises:
+        FileNotFoundError: If TOML file is not found.
+        Exception        : If failed to read TOML file.
+
+    Returns:
+        dict[str, Any]: TOML file data as dictionary.
+    """
+
+    _data: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not await aiofiles.os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' TOML file!")
+
+    try:
+        _content: str = ""
+        if _binary_toml:
+            async with aiofiles.open(file_path, "rb") as _file:
+                _content = await _file.read()  # type: ignore
+                _data = tomllib.load(_content) or {}
+        else:
+            async with aiofiles.open(file_path, "r", encoding="utf-8") as _file:
+                _content = await _file.read()  # type: ignore
+                _data = tomllib.loads(_content) or {}
+
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' TOML file!")
+        raise
+
+    return _data
+
+
+@validate_call
+async def async_read_ini_file(file_path: str | Path) -> dict[str, Any]:
+    """Asynchronous read INI config file.
+
+    Args:
+        file_path (str | Path, required): INI config file path.
+
+    Raises:
+        FileNotFoundError: If INI config file is not found.
+        Exception        : If failed to read INI config file.
+
+    Returns:
+        dict[str, Any]: INI config file data as dictionary.
+    """
+
+    _config: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not await aiofiles.os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' INI config file!")
+
+    try:
+        _content: str = ""
+        async with aiofiles.open(file_path, "r", encoding="utf-8") as _file:
+            _content = await _file.read()
+
+        _config_parser = configparser.ConfigParser()
+        _config_parser.read_string(_content)
+        for _section in _config_parser.sections():
+            _config[_section] = dict(_config_parser.items(_section))
+
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' INI config file!")
+        raise
+
+    return _config
+
+
+@validate_call
+async def async_read_config_file(config_path: str | Path) -> dict[str, Any]:
+    """Asynchronous read config file (YAML, JSON, TOML, INI).
+
+    Args:
+        config_path (str | Path, required): Config file path.
+
+    Raises:
+        FileNotFoundError: If config file is not found.
+        ValueError        : If config file format is not supported.
+
+    Returns:
+        dict[str, Any]: Config file data as dictionary.
+    """
+
+    _config: dict[str, Any] = {}
+
+    if isinstance(config_path, str):
+        config_path = Path(config_path)
+
+    if not await aiofiles.os.path.isfile(config_path):
+        raise FileNotFoundError(f"Not found '{config_path}' config file!")
+
+    _suffix = config_path.suffix.lower()
+    if _suffix in (".yaml", ".yml"):
+        _config = await async_read_yaml_file(config_path)
+    elif _suffix == ".json":
+        _config = await async_read_json_file(config_path)
+    elif _suffix == ".toml":
+        _config = await async_read_toml_file(config_path)
+    elif _suffix in (".ini", ".cfg"):
+        _config = await async_read_ini_file(config_path)
+    else:
+        raise ValueError(
+            f"Unsupported config file format '{_suffix}' for '{config_path}'!"
+        )
+
+    return _config
+
+
 __all__ = [
     "async_create_dir",
     "async_remove_dir",
@@ -283,4 +486,9 @@ __all__ = [
     "async_remove_file",
     "async_remove_files",
     "async_get_file_checksum",
+    "async_read_yaml_file",
+    "async_read_json_file",
+    "async_read_toml_file",
+    "async_read_ini_file",
+    "async_read_config_file",
 ]

potato_util/io/_sync.py

@@ -1,11 +1,28 @@
+# noqa: E402
+
 import os
+import sys
+import json
 import errno
 import shutil
 import hashlib
 import logging
+import configparser
+from pathlib import Path
+from typing import Any
+
+_binary_toml = False
+if sys.version_info >= (3, 11):
+    import tomllib  # type: ignore
+
+    _binary_toml = True
+else:
+    import toml as tomllib  # type: ignore
 
+import yaml
 from pydantic import validate_call
 
+
 from ..constants import WarnEnum, HashAlgoEnum, MAX_PATH_LENGTH
 
 
@@ -270,6 +287,185 @@ def get_file_checksum(
     return _file_checksum
 
 
+@validate_call
+def read_yaml_file(file_path: str | Path) -> dict[str, Any]:
+    """Read YAML file.
+
+    Args:
+        file_path (str | Path, required): YAML file path.
+
+    Raises:
+        FileNotFoundError: If YAML file is not found.
+        Exception        : If failed to read YAML file.
+
+    Returns:
+        dict[str, Any]: YAML file data as dictionary.
+    """
+
+    _data: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' YAML file!")
+
+    try:
+        with open(file_path, encoding="utf-8") as _file:
+            _data = yaml.safe_load(_file) or {}
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' YAML file!")
+        raise
+
+    return _data
+
+
+@validate_call
+def read_json_file(file_path: str | Path) -> dict[str, Any]:
+    """Read JSON file.
+
+    Args:
+        file_path (str | Path, required): JSON file path.
+
+    Raises:
+        FileNotFoundError: If JSON file is not found.
+        Exception        : If failed to read JSON file.
+
+    Returns:
+        dict[str, Any]: JSON file data as dictionary.
+    """
+
+    _data: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' JSON file!")
+
+    try:
+        with open(file_path, encoding="utf-8") as _file:
+            _data = json.load(_file) or {}
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' JSON file!")
+        raise
+
+    return _data
+
+
+@validate_call
+def read_toml_file(file_path: str | Path) -> dict[str, Any]:
+    """Read TOML file.
+
+    Args:
+        file_path (str | Path, required): TOML file path.
+
+    Raises:
+        FileNotFoundError: If TOML file is not found.
+        Exception        : If failed to read TOML file.
+
+    Returns:
+        dict[str, Any]: TOML file data as dictionary.
+    """
+
+    _data: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' TOML file!")
+
+    try:
+        if _binary_toml:
+            with open(file_path, "rb") as _file:
+                _data = tomllib.load(_file) or {}  # type: ignore
+        else:
+            with open(file_path, encoding="utf-8") as _file:
+                _data = tomllib.load(_file) or {}  # type: ignore
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' TOML file!")
+        raise
+
+    return _data
+
+
+@validate_call
+def read_ini_file(file_path: str | Path) -> dict[str, Any]:
+    """Read INI config file.
+
+    Args:
+        file_path (str | Path, required): INI config file path.
+
+    Raises:
+        FileNotFoundError: If INI config file is not found.
+        Exception        : If failed to read INI config file.
+
+    Returns:
+        dict[str, Any]: INI config file data as dictionary.
+    """
+
+    _config: dict[str, Any] = {}
+
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+
+    if not os.path.isfile(file_path):
+        raise FileNotFoundError(f"Not found '{file_path}' INI config file!")
+
+    try:
+        _config_parser = configparser.ConfigParser()
+        _config_parser.read(file_path)
+        for _section in _config_parser.sections():
+            _config[_section] = dict(_config_parser.items(_section))
+
+    except Exception:
+        logger.error(f"Failed to read '{file_path}' INI config file!")
+        raise
+
+    return _config
+
+
+@validate_call
+def read_config_file(config_path: str | Path) -> dict[str, Any]:
+    """Read config file (YAML, JSON, TOML, INI).
+
+    Args:
+        config_path (str | Path, required): Config file path.
+
+    Raises:
+        FileNotFoundError: If config file is not found.
+        ValueError       : If config file format is not supported.
+
+    Returns:
+        dict[str, Any]: Config file data as dictionary.
+    """
+
+    _config: dict[str, Any] = {}
+
+    if isinstance(config_path, str):
+        config_path = Path(config_path)
+
+    if not os.path.isfile(config_path):
+        raise FileNotFoundError(f"Not found '{config_path}' config file!")
+
+    _suffix = config_path.suffix.lower()
+    if _suffix in (".yaml", ".yml"):
+        _config = read_yaml_file(file_path=config_path)
+    elif _suffix == ".json":
+        _config = read_json_file(file_path=config_path)
+    elif _suffix == ".toml":
+        _config = read_toml_file(file_path=config_path)
+    elif _suffix in (".ini", ".cfg"):
+        _config = read_ini_file(file_path=config_path)
+    else:
+        raise ValueError(
+            f"Unsupported config file format '{config_path.suffix}' for '{config_path}'!"
+        )
+
+    return _config
+
+
 __all__ = [
     "create_dir",
     "remove_dir",
@@ -277,4 +473,9 @@ __all__ = [
     "remove_file",
     "remove_files",
     "get_file_checksum",
+    "read_yaml_file",
+    "read_json_file",
+    "read_toml_file",
+    "read_ini_file",
+    "read_config_file",
 ]

{potato_util-0.0.5.dist-info → potato_util-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: potato_util
-Version: 0.0.5
+Version: 0.2.0
 Summary: 'potato_util' is collection of simple useful utils package for python.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-python-utils
@@ -21,26 +21,28 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: <4.0,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: toml>=0.10.2; python_version < "3.11"
+Requires-Dist: PyYAML<7.0.0,>=6.0.2
 Requires-Dist: python-dotenv<2.0.0,>=1.0.1
 Requires-Dist: pydantic[email,timezone]<3.0.0,>=2.0.3
 Requires-Dist: pydantic-settings<3.0.0,>=2.2.1
 Provides-Extra: async
-Requires-Dist: aiofiles<25.0.0,>=24.1.0; extra == "async"
+Requires-Dist: aiofiles<26.0.0,>=24.1.0; extra == "async"
 Requires-Dist: aioshutil<2.0.0,>=1.5; extra == "async"
 Requires-Dist: aiohttp<4.0.0,>=3.11.18; extra == "async"
 Provides-Extra: fastapi
 Requires-Dist: fastapi<1.0.0,>=0.109.2; extra == "fastapi"
 Provides-Extra: all
-Requires-Dist: aiofiles<25.0.0,>=24.1.0; extra == "all"
+Requires-Dist: aiofiles<26.0.0,>=24.1.0; extra == "all"
 Requires-Dist: aioshutil<2.0.0,>=1.5; extra == "all"
 Requires-Dist: aiohttp<4.0.0,>=3.11.18; extra == "all"
 Requires-Dist: fastapi<1.0.0,>=0.109.2; extra == "all"
 Provides-Extra: test
-Requires-Dist: aiofiles<25.0.0,>=24.1.0; extra == "test"
+Requires-Dist: aiofiles<26.0.0,>=24.1.0; extra == "test"
 Requires-Dist: aioshutil<2.0.0,>=1.5; extra == "test"
 Requires-Dist: aiohttp<4.0.0,>=3.11.18; extra == "test"
 Requires-Dist: fastapi<1.0.0,>=0.109.2; extra == "test"
-Requires-Dist: pytest<9.0.0,>=8.0.2; extra == "test"
+Requires-Dist: pytest<10.0.0,>=8.0.2; extra == "test"
 Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == "test"
 Requires-Dist: pytest-xdist<4.0.0,>=3.6.1; extra == "test"
 Requires-Dist: pytest-benchmark<6.0.0,>=5.0.1; extra == "test"
@@ -50,17 +52,17 @@ Requires-Dist: wheel<1.0.0,>=0.43.0; extra == "build"
 Requires-Dist: build<2.0.0,>=1.1.1; extra == "build"
 Requires-Dist: twine<7.0.0,>=6.0.1; extra == "build"
 Provides-Extra: docs
-Requires-Dist: pylint<4.0.0,>=3.0.4; extra == "docs"
+Requires-Dist: pylint<5.0.0,>=3.0.4; extra == "docs"
 Requires-Dist: mkdocs-material<10.0.0,>=9.5.50; extra == "docs"
 Requires-Dist: mkdocs-awesome-nav<4.0.0,>=3.0.0; extra == "docs"
 Requires-Dist: mkdocstrings[python]<1.0.0,>=0.24.3; extra == "docs"
 Requires-Dist: mike<3.0.0,>=2.1.3; extra == "docs"
 Provides-Extra: dev
-Requires-Dist: aiofiles<25.0.0,>=24.1.0; extra == "dev"
+Requires-Dist: aiofiles<26.0.0,>=24.1.0; extra == "dev"
 Requires-Dist: aioshutil<2.0.0,>=1.5; extra == "dev"
 Requires-Dist: aiohttp<4.0.0,>=3.11.18; extra == "dev"
 Requires-Dist: fastapi<1.0.0,>=0.109.2; extra == "dev"
-Requires-Dist: pytest<9.0.0,>=8.0.2; extra == "dev"
+Requires-Dist: pytest<10.0.0,>=8.0.2; extra == "dev"
 Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == "dev"
 Requires-Dist: pytest-xdist<4.0.0,>=3.6.1; extra == "dev"
 Requires-Dist: pytest-benchmark<6.0.0,>=5.0.1; extra == "dev"
@@ -68,7 +70,7 @@ Requires-Dist: setuptools<81.0.0,>=70.3.0; extra == "dev"
 Requires-Dist: wheel<1.0.0,>=0.43.0; extra == "dev"
 Requires-Dist: build<2.0.0,>=1.1.1; extra == "dev"
 Requires-Dist: twine<7.0.0,>=6.0.1; extra == "dev"
-Requires-Dist: pylint<4.0.0,>=3.0.4; extra == "dev"
+Requires-Dist: pylint<5.0.0,>=3.0.4; extra == "dev"
 Requires-Dist: mkdocs-material<10.0.0,>=9.5.50; extra == "dev"
 Requires-Dist: mkdocs-awesome-nav<4.0.0,>=3.0.0; extra == "dev"
 Requires-Dist: mkdocstrings[python]<1.0.0,>=0.24.3; extra == "dev"

{potato_util-0.0.5.dist-info → potato_util-0.2.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 potato_util/__init__.py,sha256=xl4th2Z_OmTk-3aO1w05Vh8ob0BnX4RcY1fT9tGX61c,74
-potato_util/__version__.py,sha256=S7u1lbuWmM3A3ajykBialmPoJUK6Jg-WmNqM-9OZFdk,22
-potato_util/_base.py,sha256=yWj687li7meg1d7AH1e5rztoyL7z59JunKcBGoDUUJs,2014
+potato_util/__version__.py,sha256=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
+potato_util/_base.py,sha256=oKLzp_NheI7kQAKC5xAm77OI_UmBXRuEEpulZTVBg5w,2549
 potato_util/dt.py,sha256=DatLzuXOxdanplBv-Kf3qOaomrTCUUBSYv_QgTtQB6U,7635
 potato_util/generator.py,sha256=vdvHj1UrCOQI2WXQHQ2H63PMLQ6yOXAZPNl0m-6BgtY,1572
 potato_util/sanitizer.py,sha256=pZuMDvZxKKIdwFKTcqfmHb9ji-UefSgRgJ8ynHG6UFs,2267
@@ -16,10 +16,10 @@ potato_util/http/_base.py,sha256=qoW5U8gxihVMx3v1gSLLmptMjScVsDS9PowvJ6tTc9c,143
 potato_util/http/_sync.py,sha256=i8oyRmh-WraOzotaUbssIjOPvBh1pvLPupdoCvyHTK0,1169
 potato_util/http/fastapi.py,sha256=iqCxZcQDIVtcqCN9dZ4itcoUs6KzsfRGgK7sRd5EmOA,675
 potato_util/io/__init__.py,sha256=FoGcN7t0uArQV4hbMR1X5aeC8Yq-h_ds4xooNpkmgG0,209
-potato_util/io/_async.py,sha256=XVNFDCRII-ib32tksxj5G3nDLsV-ylTW2Hw3_seIY-k,10012
-potato_util/io/_sync.py,sha256=ZVRukOYWWvXtVlU_Gf8GoKnQZqSI2LISHPMmxXi4-2U,9644
-potato_util-0.0.5.dist-info/licenses/LICENSE.txt,sha256=CUTK-r0BWIg1r0bBiemAcMhakgV0N7HuRhw6rQ-A9A4,1074
-potato_util-0.0.5.dist-info/METADATA,sha256=N5tIucIltyII95e7Q46MW_p8pmUmrfBvUkO_ntDBreQ,15634
-potato_util-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-potato_util-0.0.5.dist-info/top_level.txt,sha256=pLMnSfT6rhlYBpo2Gnd8kKMDxcuvxdVizqsv1dd1frw,12
-potato_util-0.0.5.dist-info/RECORD,,
+potato_util/io/_async.py,sha256=TViNNR1yHGMoSk-YuBBo7n7FdHcIiu1wMJqc9B7eJDY,15855
+potato_util/io/_sync.py,sha256=sTu0D9zQBmnPYnERFVWohKYNM6FJycAQ_WXkCNsVJuE,14828
+potato_util-0.2.0.dist-info/licenses/LICENSE.txt,sha256=CUTK-r0BWIg1r0bBiemAcMhakgV0N7HuRhw6rQ-A9A4,1074
+potato_util-0.2.0.dist-info/METADATA,sha256=T9U6_lYuXtH9x9OqpXNQc6X2V2fCdCdP98t0Z2OSb_o,15725
+potato_util-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+potato_util-0.2.0.dist-info/top_level.txt,sha256=pLMnSfT6rhlYBpo2Gnd8kKMDxcuvxdVizqsv1dd1frw,12
+potato_util-0.2.0.dist-info/RECORD,,