Dev (#294)

* Start work on HTTPX utils improvements (#290)

* Update demo().

Add vscode workspace.

Update httpx validators.

Move file_utils -> path_utils

* Merge changes from main (#293)

* Dev (#291)

* Start work on HTTPX utils improvements (#290)

* Update demo().

Add vscode workspace.

Update httpx validators.

Move file_utils -> path_utils

* release(v0.2.9): (#292)

Rename file_utils -> path_utils.

Improve validators.

Add core.constants, with directory consts like DATA_DIR and CACHE_DIR.

TODO: replace any data/cache/serialize dir references with the new constants

* remove old references to hardcoded data/cache/serialize dirs.

Replace references with new core.constant values

* Fix LOG_DIR import

Author: redjax

red_utils/core/__init__.py

@@ -2,4 +2,11 @@
 
 from . import dataclass_utils, constants
 
-from .constants import DATA_DIR, CACHE_DIR, SERIALIZE_DIR, JSON_DIR, ENSURE_EXIST_DIRS
+from .constants import (
+    DATA_DIR,
+    CACHE_DIR,
+    SERIALIZE_DIR,
+    JSON_DIR,
+    ENSURE_EXIST_DIRS,
+    LOG_DIR,
+)

red_utils/core/constants.py

@@ -4,5 +4,6 @@
 CACHE_DIR: Path = Path(".cache")
 SERIALIZE_DIR: Path = Path(".serialize")
 JSON_DIR: Path = Path(f"{DATA_DIR}/json")
+LOG_DIR: Path = Path("logs")
 
-ENSURE_EXIST_DIRS: list[Path] = [DATA_DIR, CACHE_DIR, SERIALIZE_DIR]
+ENSURE_EXIST_DIRS: list[Path] = [DATA_DIR, CACHE_DIR, SERIALIZE_DIR, LOG_DIR]

red_utils/ext/diskcache_utils/__init__.py

@@ -4,12 +4,13 @@
 
 from .classes import CacheInstance
 from .constants import (
-    default_cache_dir,
     default_timeout_dict,
     valid_key_types,
     valid_tag_types,
     valid_val_types,
 )
+from red_utils.core.constants import CACHE_DIR
+
 from .operations import (
     check_cache,
     check_cache_key_exists,
@@ -36,7 +37,7 @@
 
 ## Define a default cache object
 default_cache_conf: dict[str, Any] = {
-    "directory": default_cache_dir,
+    "directory": CACHE_DIR,
     "timeout": convert_to_seconds(
         unit=default_timeout_dict["unit"], amount=default_timeout_dict["amount"]
     ),

red_utils/ext/diskcache_utils/classes.py

@@ -5,8 +5,8 @@
 from typing import Any, Union
 
 from red_utils.std.dataclass_mixins import DictMixin
+from red_utils.core.constants import CACHE_DIR
 
-from .constants import default_cache_dir
 from .operations import (
     check_cache,
     check_cache_key_exists,
@@ -34,6 +34,7 @@
 from diskcache import Cache
 from diskcache.core import warnings
 
+
 def default_timeout() -> int:
     timeout = convert_to_seconds(amount=24, unit="hours")
     return timeout
@@ -46,7 +47,7 @@ class CacheInstanceBase(DictMixin):
     Implement functionality from operations.py, such as get_val and set_val.
     """
 
-    cache_dir: Union[str, Path] | None = field(default=default_cache_dir)
+    cache_dir: Union[str, Path] | None = field(default=CACHE_DIR)
     index: bool = field(default=True)
     cache: Cache | None = field(default=None)
     cache_timeout: int | None = field(default_factory=default_timeout)

red_utils/ext/diskcache_utils/constants.py

@@ -21,7 +21,7 @@ class TimeoutConf(DictMixin):
     amount: int | None = field(default=15)
 
 
-default_cache_dir: str = ".cache"
+# default_cache_dir: str = ".cache"
 ## Set default timeout to 24 hours
 # default_timeout_dict: dict[str, Union[str, int]] = {"unit": "minutes", "amount": 15}
 

red_utils/ext/diskcache_utils/operations.py

@@ -8,8 +8,9 @@
 from pathlib import Path
 from typing import Optional, Type, Union
 
+from red_utils.core.constants import CACHE_DIR
+
 from .constants import (
-    default_cache_dir,
     default_timeout_dict,
     valid_key_types,
     valid_tag_types,
@@ -30,6 +31,7 @@
 
 from diskcache import Cache
 
+
 def convert_to_seconds(amount: int = None, unit: str = None) -> int:
     """Convert an amount of time to seconds.
 
@@ -77,7 +79,7 @@ def convert_to_seconds(amount: int = None, unit: str = None) -> int:
 
 
 def new_cache(
-    cache_dir: str = default_cache_dir,
+    cache_dir: str = CACHE_DIR,
     cache_conf: dict = None,
     index: bool = True,
 ) -> diskcache.core.Cache:

red_utils/ext/loguru_utils/__init__.py

@@ -6,7 +6,6 @@
     LogLevel,
     default_color_fmt,
     default_fmt,
-    default_log_dir,
     log_levels,
     uvicorn_log_conf,
     valid_compression_strs,

red_utils/ext/loguru_utils/constants.py

@@ -19,7 +19,7 @@
 default_color_fmt: str = f"<green>{_ts}</green> <level>{_level}</level> > <level>{_name_line}</level>: {_msg}"
 # default_fmt: str = "[{time:YYYY-MM-DD_HH:mm:ss}] [{level}] | [{name}:{line}]: {message}"
 # default_color_fmt: str = "<green>[{time:YYYY-MM-DD_HH:mm:ss}]</green> <level>[{level}]</level> | [{name}:{line}]: {message}"
-default_log_dir: str = "logs"
+# default_log_dir: str = "logs"
 
 
 @dataclass

red_utils/ext/msgpack_utils/__init__.py

@@ -2,7 +2,6 @@
 
 from . import classes, constants, operations, validators
 from .classes import SerialFunctionResponse
-from .constants import default_serialize_dir
 from .operations import (
     ensure_path,
     msgpack_deserialize,

red_utils/ext/msgpack_utils/constants.py

@@ -1,3 +1 @@
 from __future__ import annotations
-
-default_serialize_dir: str = ".serialize"

red_utils/ext/msgpack_utils/operations.py

@@ -5,10 +5,11 @@
 from uuid import uuid4
 
 from .classes import SerialFunctionResponse
-from .constants import default_serialize_dir
+from red_utils.core.constants import SERIALIZE_DIR
 
 import msgpack
 
+
 def ensure_path(dir: Union[str, Path] = None) -> bool:
     """Ensure a directory path exists.
 
@@ -76,7 +77,7 @@ def msgpack_serialize(
 
 
 def msgpack_serialize_file(
-    _json: dict = None, output_dir: str = default_serialize_dir, filename: str = None
+    _json: dict = None, output_dir: str = SERIALIZE_DIR, filename: str = None
 ) -> (
     SerialFunctionResponse
 ):  ## dict[str, Union[bool, str, dict[str, Union[str, dict]]]]: