python-backpack 2.0.4__py3-none-any.whl → 2.0.5__py3-none-any.whl

backpack/json_utils.py

@@ -1,53 +1,53 @@
-import json
-import os
-
-from backpack.logger import get_logger
-
-log = get_logger('Python Backpack - JsonUtils')
-
-
-def json_load(json_file: str) -> dict:
-    """Reads a json file.
-
-    Args:
-        json_file: (string filepath) json file to read data.
-
-    Returns:
-        dict (file content)
-    """
-    if not os.path.exists(json_file):
-        raise OSError(f'json_load: File not found: {json_file}.')
-
-    with open(json_file, encoding='utf-8') as json_file_opened:
-        try:
-            value = json.load(json_file_opened)
-        except ValueError as e:
-            raise OSError(f'{json_file} \n JSON File issue: {str(e)}') from e
-
-    return value
-
-
-def json_save(data: object, json_file: str) -> bool:
-    """Saves a dictionary into a json file.
-
-    Args:
-        data: value to serialize as JSON
-        json_file: (string filepath) json file to save data.
-
-    Returns:
-        bool (True if success)
-    """
-
-    parent_dir = os.path.dirname(json_file)
-    if parent_dir and not os.path.exists(parent_dir):
-        os.makedirs(parent_dir, exist_ok=True)
-
-    try:
-        with open(json_file, 'w', encoding='utf-8') as f:
-            json.dump(data, f, sort_keys=True, indent=4)
-            return True
-
-    except (OSError, TypeError) as e:
-        log.error(f'{e} - {json_file}')
-
-    return False
+import json
+import os
+
+from backpack.logger import get_logger
+
+log = get_logger('Python Backpack - JsonUtils')
+
+
+def json_load(json_file: str) -> dict:
+    """Reads a json file.
+
+    Args:
+        json_file: (string filepath) json file to read data.
+
+    Returns:
+        dict (file content)
+    """
+    if not os.path.exists(json_file):
+        raise OSError(f'json_load: File not found: {json_file}.')
+
+    with open(json_file, encoding='utf-8') as json_file_opened:
+        try:
+            value = json.load(json_file_opened)
+        except ValueError as e:
+            raise OSError(f'{json_file} \n JSON File issue: {str(e)}') from e
+
+    return value
+
+
+def json_save(data: object, json_file: str) -> bool:
+    """Saves a dictionary into a json file.
+
+    Args:
+        data: value to serialize as JSON
+        json_file: (string filepath) json file to save data.
+
+    Returns:
+        bool (True if success)
+    """
+
+    parent_dir = os.path.dirname(json_file)
+    if parent_dir and not os.path.exists(parent_dir):
+        os.makedirs(parent_dir, exist_ok=True)
+
+    try:
+        with open(json_file, 'w', encoding='utf-8') as f:
+            json.dump(data, f, sort_keys=True, indent=4)
+            return True
+
+    except (OSError, TypeError) as e:
+        log.error(f'{e} - {json_file}')
+
+    return False

backpack/logger.py

@@ -1,16 +1,16 @@
-import logging
-
-
-def get_logger(name: str) -> logging.Logger:
-    """Returns a logger object with a stream handler."""
-    _log = logging.getLogger(name)
-    _log.propagate = False
-    _log.setLevel(logging.DEBUG)
-    if len(_log.handlers) == 0:
-        stream_handler = logging.StreamHandler()
-        format_str = '%(levelname)-7s | %(message)s'
-        formatter = logging.Formatter(format_str)
-        stream_handler.setFormatter(formatter)
-        _log.addHandler(stream_handler)
-
-    return _log
+import logging
+
+
+def get_logger(name: str) -> logging.Logger:
+    """Returns a logger object with a stream handler."""
+    _log = logging.getLogger(name)
+    _log.propagate = False
+    _log.setLevel(logging.DEBUG)
+    if len(_log.handlers) == 0:
+        stream_handler = logging.StreamHandler()
+        format_str = '%(levelname)-7s | %(message)s'
+        formatter = logging.Formatter(format_str)
+        stream_handler.setFormatter(formatter)
+        _log.addHandler(stream_handler)
+
+    return _log

backpack/patterns.py

@@ -1,28 +1,28 @@
-# ----------------------------------------------------------------------------------------
-# Python-Backpack - Pattern Utilities
-# Maximiliano Rocamora / maxirocamora@gmail.com
-# https://github.com/MaxRocamora/python-backpack
-# ----------------------------------------------------------------------------------------
-
-
-class Singleton:
-    """Python Singleton BaseClass.
-
-    Usage:
-
-        class MyClass(Singleton, otherClass):
-            pass
-
-        obj = MyClass() # any new object will be taken from the same instance
-
-    """
-
-    _instance = None
-
-    def __new__(cls, *args, **kwargs):
-        """Singleton __new__ method."""
-        if not isinstance(cls._instance, cls):
-            # print(f'Initializing {cls.__name__}')
-            cls._instance = object.__new__(cls)
-        # print(f'Restoring {class_.__name__}')
-        return cls._instance
+# ----------------------------------------------------------------------------------------
+# Python-Backpack - Pattern Utilities
+# Maximiliano Rocamora / maxirocamora@gmail.com
+# https://github.com/MaxRocamora/python-backpack
+# ----------------------------------------------------------------------------------------
+
+
+class Singleton:
+    """Python Singleton BaseClass.
+
+    Usage:
+
+        class MyClass(Singleton, otherClass):
+            pass
+
+        obj = MyClass() # any new object will be taken from the same instance
+
+    """
+
+    _instance = None
+
+    def __new__(cls, *args, **kwargs):
+        """Singleton __new__ method."""
+        if not isinstance(cls._instance, cls):
+            # print(f'Initializing {cls.__name__}')
+            cls._instance = object.__new__(cls)
+        # print(f'Restoring {class_.__name__}')
+        return cls._instance

backpack/strings.py

@@ -1,123 +1,123 @@
-# ----------------------------------------------------------------------------------------
-# Python-Backpack - String Verification Methods
-# Maximiliano Rocamora / maxirocamora@gmail.com
-# https://github.com/MaxRocamora/python-backpack
-# ----------------------------------------------------------------------------------------
-
-import re
-
-
-def normalize_input_string(
-    input_string: str,
-    under_spaces: bool = True,
-    under_hyphen: bool = True,
-    replacer: str = '_',
-) -> str:
-    """Reformat the user input string.
-
-    leaves only alphanumeric chars
-    replaces spaces and hyphens for underscores.
-
-    Args:
-        input_string (str): input string to reformat
-        under_spaces (bool, optional): replaces spaces. Defaults to True.
-        under_hyphen (bool, optional): replaces hyphens. Defaults to True.
-        replacer (str, optional): char to replace spaces and hyphens. Defaults to '_'.
-
-    Returns:
-        str: reformatted string
-    """
-
-    regex = re.sub(r'[^A-Za-z0-9 _-]+', '', input_string)
-    if under_spaces:
-        regex = regex.replace(' ', replacer)
-    if under_hyphen:
-        regex = regex.replace('-', replacer)
-
-    return regex
-
-
-def begin_or_end_with_numbers(input_string: str) -> bool:
-    """Returns true if the input string begins or ends with number."""
-    return bool(input_string) and (
-        _char_is_number(input_string[0]) or _char_is_number(input_string[-1])
-    )
-
-
-def begin_with_number(input_string: str) -> bool:
-    """Returns true if the input string begins with numbers."""
-    return bool(input_string) and _char_is_number(input_string[0])
-
-
-def has_numbers(input_string: str) -> bool:
-    """Returns true if the input string has numbers."""
-    return any(_char_is_number(char) for char in input_string)
-
-
-def _char_is_number(char: str) -> bool:
-    """Check if a string is a number.
-
-    Args:
-        char (str): character to evaluate
-
-    Returns:
-        bool: True if is a int
-    """
-
-    try:
-        int(char)
-        return True
-    except ValueError:
-        return False
-
-
-def camelcase_to_snakecase(input_string: str) -> str:
-    """Convert a CamelCase string to snake_case string.
-
-    Args:
-        input_string (str): The CamelCase string to be converted.
-
-    Returns:
-        str: The converted snake_case string.
-
-    Examples:
-        OneDayCaseChar > one_day_case_char
-        oneCamelCaseChar > one_camel_case_char
-        HTTPServer > http_server
-        _TwoCamel_CaseChar > _two_camel_case_char
-        _LeadingUnderscore_case_ > _leading_underscore_case_
-    """
-
-    snake_str = ''
-
-    # iterate over the string
-    for index, char in enumerate(input_string):
-        if not char.isalnum():
-            snake_str += char
-            continue
-
-        if not char.isupper():
-            snake_str += char
-            continue
-
-        prev_char = input_string[index - 1] if index > 0 else ''
-        next_char = input_string[index + 1] if index + 1 < len(input_string) else ''
-
-        # Add underscore only at real word boundaries.
-        # This keeps acronyms together: HTTPServer -> http_server.
-        should_add_underscore = (
-            index > 0
-            and prev_char != '_'
-            and (
-                prev_char.islower()
-                or prev_char.isdigit()
-                or (prev_char.isupper() and next_char.islower())
-            )
-        )
-
-        if should_add_underscore:
-            snake_str += '_'
-
-        snake_str += char.lower()
-
-    return snake_str
+# ----------------------------------------------------------------------------------------
+# Python-Backpack - String Verification Methods
+# Maximiliano Rocamora / maxirocamora@gmail.com
+# https://github.com/MaxRocamora/python-backpack
+# ----------------------------------------------------------------------------------------
+
+import re
+
+
+def normalize_input_string(
+    input_string: str,
+    under_spaces: bool = True,
+    under_hyphen: bool = True,
+    replacer: str = '_',
+) -> str:
+    """Reformat the user input string.
+
+    leaves only alphanumeric chars
+    replaces spaces and hyphens for underscores.
+
+    Args:
+        input_string (str): input string to reformat
+        under_spaces (bool, optional): replaces spaces. Defaults to True.
+        under_hyphen (bool, optional): replaces hyphens. Defaults to True.
+        replacer (str, optional): char to replace spaces and hyphens. Defaults to '_'.
+
+    Returns:
+        str: reformatted string
+    """
+
+    regex = re.sub(r'[^A-Za-z0-9 _-]+', '', input_string)
+    if under_spaces:
+        regex = regex.replace(' ', replacer)
+    if under_hyphen:
+        regex = regex.replace('-', replacer)
+
+    return regex
+
+
+def begin_or_end_with_numbers(input_string: str) -> bool:
+    """Returns true if the input string begins or ends with number."""
+    return bool(input_string) and (
+        _char_is_number(input_string[0]) or _char_is_number(input_string[-1])
+    )
+
+
+def begin_with_number(input_string: str) -> bool:
+    """Returns true if the input string begins with numbers."""
+    return bool(input_string) and _char_is_number(input_string[0])
+
+
+def has_numbers(input_string: str) -> bool:
+    """Returns true if the input string has numbers."""
+    return any(_char_is_number(char) for char in input_string)
+
+
+def _char_is_number(char: str) -> bool:
+    """Check if a string is a number.
+
+    Args:
+        char (str): character to evaluate
+
+    Returns:
+        bool: True if is a int
+    """
+
+    try:
+        int(char)
+        return True
+    except ValueError:
+        return False
+
+
+def camelcase_to_snakecase(input_string: str) -> str:
+    """Convert a CamelCase string to snake_case string.
+
+    Args:
+        input_string (str): The CamelCase string to be converted.
+
+    Returns:
+        str: The converted snake_case string.
+
+    Examples:
+        OneDayCaseChar > one_day_case_char
+        oneCamelCaseChar > one_camel_case_char
+        HTTPServer > http_server
+        _TwoCamel_CaseChar > _two_camel_case_char
+        _LeadingUnderscore_case_ > _leading_underscore_case_
+    """
+
+    snake_str = ''
+
+    # iterate over the string
+    for index, char in enumerate(input_string):
+        if not char.isalnum():
+            snake_str += char
+            continue
+
+        if not char.isupper():
+            snake_str += char
+            continue
+
+        prev_char = input_string[index - 1] if index > 0 else ''
+        next_char = input_string[index + 1] if index + 1 < len(input_string) else ''
+
+        # Add underscore only at real word boundaries.
+        # This keeps acronyms together: HTTPServer -> http_server.
+        should_add_underscore = (
+            index > 0
+            and prev_char != '_'
+            and (
+                prev_char.islower()
+                or prev_char.isdigit()
+                or (prev_char.isupper() and next_char.islower())
+            )
+        )
+
+        if should_add_underscore:
+            snake_str += '_'
+
+        snake_str += char.lower()
+
+    return snake_str

backpack/test_utils.py

@@ -1,48 +1,48 @@
-# ----------------------------------------------------------------------------------------
-# Python-Backpack - Test Utilities
-# Maximiliano Rocamora / maxirocamora@gmail.com
-# https://github.com/MaxRocamora/python-backpack
-# ----------------------------------------------------------------------------------------
-import random
-import string
-import time
-from functools import wraps
-from typing import Callable, ParamSpec, TypeVar
-
-from backpack.logger import get_logger
-
-log = get_logger('Python Backpack - TestUtils')
-
-P = ParamSpec('P')
-R = TypeVar('R')
-
-
-def random_string(length: int = 10) -> str:
-    """Generates a random string of fixed length.
-
-    Args:
-        length (int, optional): max string length. Defaults to 10.
-
-    Returns:
-        str: random string
-    """
-
-    letters = string.ascii_lowercase
-    return ''.join(random.choice(letters) for _ in range(length))
-
-
-def time_function_decorator(method: Callable[P, R]) -> Callable[P, R]:
-    """Decorator to measure methods execution time."""
-
-    @wraps(method)
-    def timed(*args: P.args, **kw: P.kwargs) -> R:
-        ts = time.perf_counter()
-        result = method(*args, **kw)
-        te = time.perf_counter()
-
-        message = f'{method.__name__!r}  {(te - ts) * 1000:2.2f} ms'
-        log.info(message)
-
-        return result
-
-    return timed
+# ----------------------------------------------------------------------------------------
+# Python-Backpack - Test Utilities
+# Maximiliano Rocamora / maxirocamora@gmail.com
+# https://github.com/MaxRocamora/python-backpack
+# ----------------------------------------------------------------------------------------
+import random
+import string
+import time
+from functools import wraps
+from typing import Callable, ParamSpec, TypeVar
+
+from backpack.logger import get_logger
+
+log = get_logger('Python Backpack - TestUtils')
+
+P = ParamSpec('P')
+R = TypeVar('R')
+
+
+def random_string(length: int = 10) -> str:
+    """Generates a random string of fixed length.
+
+    Args:
+        length (int, optional): max string length. Defaults to 10.
+
+    Returns:
+        str: random string
+    """
+
+    letters = string.ascii_lowercase
+    return ''.join(random.choice(letters) for _ in range(length))
+
+
+def time_function_decorator(method: Callable[P, R]) -> Callable[P, R]:
+    """Decorator to measure methods execution time."""
+
+    @wraps(method)
+    def timed(*args: P.args, **kw: P.kwargs) -> R:
+        ts = time.perf_counter()
+        result = method(*args, **kw)
+        te = time.perf_counter()
+
+        message = f'{method.__name__!r}  {(te - ts) * 1000:2.2f} ms'
+        log.info(message)
+
+        return result
+
+    return timed

backpack/version.py

@@ -1,24 +1,25 @@
-# ----------------------------------------------------------------------------------------
-# 1.0.0 07/2022 - Initial Release
-# 1.0.2 07/2022 - More Methods and tests
-# 1.0.3 07/2022 - JsonMetaFile, JsonUserSettings
-# 1.0.4 04/2023 - Added camelcase_to_snakecase function
-# 1.0.5 05/2023 - Refactor JsonMetaFile, Added Cache, Some type hints / docstrings
-# 1.1.0 01/2024 - Ruff Formatting
-# 1.1.1 07/2025 - Update Python version matrix to include 3.10 and 3.11, update actions versions
-# 1.1.2 07/2025 - Update actions versions, remove unused badge from README
-# 1.1.3 07/2025 - Improve test class names and docstrings for clarity, ruff formatting
-# 1.1.4 07/2025 - Moved from pipenv to poetry for dependency management.toml
-# 2.0.1 05/2026 - Remove tox workflow and setup.py, standardize uv + coverage tooling
-# 2.0.2 05/2026 - Add PyPI long description metadata and release polish
-# 2.0.3 06/2026 - Add type hints, refactor backpack.cache to use functools.lru_cache, added tests.
-# 2.0.4 08/2026 - Fixed get_version_from_filename().
-# ----------------------------------------------------------------------------------------
-
-__version__ = '2.0.4'
-
-VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH = map(int, __version__.split('.'))
-
-version = __version__
-
-app_name = 'python-backpack'
+# ----------------------------------------------------------------------------------------
+# 1.0.0 07/2022 - Initial Release
+# 1.0.2 07/2022 - More Methods and tests
+# 1.0.3 07/2022 - JsonMetaFile, JsonUserSettings
+# 1.0.4 04/2023 - Added camelcase_to_snakecase function
+# 1.0.5 05/2023 - Refactor JsonMetaFile, Added Cache, Some type hints / docstrings
+# 1.1.0 01/2024 - Ruff Formatting
+# 1.1.1 07/2025 - Update Python version matrix to include 3.10 and 3.11, update actions versions
+# 1.1.2 07/2025 - Update actions versions, remove unused badge from README
+# 1.1.3 07/2025 - Improve test class names and docstrings for clarity, ruff formatting
+# 1.1.4 07/2025 - Moved from pipenv to poetry for dependency management.toml
+# 2.0.1 05/2026 - Remove tox workflow and setup.py, standardize uv + coverage tooling
+# 2.0.2 05/2026 - Add PyPI long description metadata and release polish
+# 2.0.3 06/2026 - Add type hints, refactor backpack.cache to use functools.lru_cache, added tests.
+# 2.0.4 08/2026 - Fixed get_version_from_filename().
+# 2.0.5 09/2026 - Add PyPI publish workflow.
+# ----------------------------------------------------------------------------------------
+
+__version__ = '2.0.5'
+
+VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH = map(int, __version__.split('.'))
+
+version = __version__
+
+app_name = 'python-backpack'

{python_backpack-2.0.4.dist-info → python_backpack-2.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: python-backpack
-Version: 2.0.4
+Version: 2.0.5
 Summary: Lightweight utilities for JSON, filesystem operations, strings, caching, and scripting.
 Project-URL: Homepage, https://github.com/MaxRocamora/python-backpack
 Project-URL: Repository, https://github.com/MaxRocamora/python-backpack.git

python_backpack-2.0.5.dist-info/RECORD

@@ -0,0 +1,17 @@
+backpack/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+backpack/cache.py,sha256=tKGtakURa5xkqoip9LPZta2g0Rufca1uh29rdkRcdKU,2978
+backpack/custom_errors.py,sha256=wQbhNcLl2f3YBoXQ_XIXZi4xqHbCjXa7ONw8-nmgidQ,1321
+backpack/file_utils.py,sha256=b7KXy4XXzsGJfTPrPiNclL1FLH_1dwDlUfE0n-Mi5R4,4311
+backpack/folder_utils.py,sha256=Kmb5R0tHIi7e-_iAyDTbBdHWJi_AP7rmtqdXUzGBko0,3160
+backpack/json_metadata.py,sha256=VrNO-d2QtHJ2YZDBOBukJie2TIgjYPVnbwcz8mSITH0,4503
+backpack/json_user_settings.py,sha256=nTnYF5uzHAnIc3ojf7Y5Av8btD0g8JJUBHo_YpQcKzM,2559
+backpack/json_utils.py,sha256=kq5eNJYPQ0i_6JKnP4pTyVAXm8D9u4ZoZnwzosUowlE,1315
+backpack/logger.py,sha256=jvkiRaLmOUn7MV-g8gYWeI7mXXXmdrOY4lTe38QIiVE,502
+backpack/patterns.py,sha256=LBayEl9MtYwHqSvoiRGgxaDcXW1P6cHbjRNO5BvDGDQ,861
+backpack/strings.py,sha256=PBB47E4G2Rd1kRuqqNDHIc_O2kai0ZVcn8obLVC3dCg,3488
+backpack/test_utils.py,sha256=G6M6da2cB7bgC_MxiClbMGC0HOzIPlICm2oQqPAKUrI,1322
+backpack/version.py,sha256=pwSBZZi0FOevw34Q_xBGS7v3Hci5EVIQrciOLV6bRDc,1326
+python_backpack-2.0.5.dist-info/METADATA,sha256=qlgRuWmUzMpGA0KB7U4AvdWHP8vLhohU6IwMsvYOWAo,6665
+python_backpack-2.0.5.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+python_backpack-2.0.5.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_backpack-2.0.5.dist-info/RECORD,,