python-sdk-remote 0.0.180b126__tar.gz → 0.0.180b127__tar.gz

{python_sdk_remote-0.0.180b126 → python_sdk_remote-0.0.180b127}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.180b126
+Version: 0.0.180b127
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles
@@ -22,4 +22,4 @@ Dynamic: home-page
 Dynamic: requires-dist
 Dynamic: summary
 
-This is a package for sharing common functions used in different repositories
+This is a package for sharing common functions used in different repositories.

{python_sdk_remote-0.0.180b126 → python_sdk_remote-0.0.180b127}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [tool.poetry]
 name = "python-sdk-local"
-version = "0.0.75" # https://pypi.org/project/python-sdk-local
+version = "0.0.76" # https://pypi.org/project/python-sdk-local
 description = "python-sdk-local Python Package"
 readme = "README.md"
 authors = [

python_sdk_remote-0.0.180b126/python_sdk_remote/src/exceptions.py → python_sdk_remote-0.0.180b127/python_sdk_remote/src/environment_variable_exception.py

@@ -1,4 +1,3 @@
-# TODO Rename the file to environment_variable_exception.py
 class EnvironmentVariableException(Exception):
     """Raised when a required environment variable is missing or empty.
 

python_sdk_remote-0.0.180b127/python_sdk_remote/src/filename.py

@@ -0,0 +1,82 @@
+import re
+import unicodedata
+
+# Characters that are illegal in filenames on Windows / most filesystems,
+# plus the ASCII control characters (0x00-0x1F).
+_INVALID_CHARS_PATTERN = re.compile(r'[<>:"/\\|?*\x00-\x1f]')
+_WHITESPACE_PATTERN = re.compile(r'\s+')
+
+# Names reserved by Windows (case-insensitive), with or without an extension.
+_RESERVED_NAMES = {
+    "CON", "PRN", "AUX", "NUL",
+    *(f"COM{i}" for i in range(1, 10)),
+    *(f"LPT{i}" for i in range(1, 10)),
+}
+
+MAX_FILENAME_LENGTH = 255
+
+
+def convert_to_valid_filename(
+    string: str,
+    replacement: str = "_",
+    max_length: int = MAX_FILENAME_LENGTH,
+    fallback: str = "file",
+) -> str:
+    """Convert an arbitrary string into a filename that is safe to use across
+    Windows, macOS and Linux.
+
+    - Normalises unicode and collapses runs of whitespace into ``replacement``.
+    - Replaces characters that are illegal on common filesystems.
+    - Strips leading/trailing dots, spaces and ``replacement`` characters.
+    - Avoids Windows reserved device names (CON, NUL, COM1, ...).
+    - Truncates to ``max_length`` characters while keeping the extension.
+    - Returns ``fallback`` when nothing usable remains.
+    """
+    if not isinstance(string, str):
+        string = str(string)
+
+    filename = unicodedata.normalize("NFKC", string)
+    filename = _INVALID_CHARS_PATTERN.sub(replacement, filename)
+    filename = _WHITESPACE_PATTERN.sub(replacement, filename)
+
+    # Trim characters that are problematic at the edges of a filename,
+    # repeating until stable so e.g. "_.._" collapses fully.
+    edge_chars = " .\t\n\r\f\v" + (replacement or "")
+    previous = None
+    while filename != previous:
+        previous = filename
+        filename = filename.strip(edge_chars)
+
+    if not filename:
+        return fallback
+
+    root, dot, extension = filename.partition(".")
+    if root.upper() in _RESERVED_NAMES:
+        root = f"{root}{replacement}"
+        filename = root + dot + extension
+
+    if len(filename) > max_length:
+        root, dot, extension = filename.rpartition(".")
+        if dot and len(extension) < max_length:
+            keep = max_length - len(dot) - len(extension)
+            filename = root[:keep] + dot + extension
+        else:
+            filename = filename[:max_length]
+        filename = filename.strip(" .")
+
+    return filename or fallback
+
+# def convert_to_valid_filename(name: str) -> str:
+#     """Reduce ``name`` to characters that are safe for a single path component.
+
+#     Every run of characters outside ``[A-Za-z0-9._-]`` (path separators,
+#     whitespace, shell metacharacters, ...) collapses to a single underscore and
+#     leading / trailing ``.``, ``-`` and ``_`` are trimmed. A falsy input or one
+#     that is left empty after sanitising yields ``"unnamed"`` so a usable name is
+#     always returned.
+#     """
+#     if not name:
+#         return _FALLBACK_FILENAME
+#     sanitized = _INVALID_FILENAME_CHARACTERS_PATTERN.sub("_", str(name))
+#     sanitized = sanitized.strip("._-")
+#     return sanitized or _FALLBACK_FILENAME

{python_sdk_remote-0.0.180b126 → python_sdk_remote-0.0.180b127}/python_sdk_remote/src/utilities.py

@@ -17,7 +17,7 @@ from .version import PACKAGE_VERSION
 
 from .mini_logger import MiniLogger as logger
 
-from .exceptions import EnvironmentVariableException
+from .environment_variable_exception import EnvironmentVariableException
 
 load_dotenv()
 # Load environment variables from .env file

{python_sdk_remote-0.0.180b126 → python_sdk_remote-0.0.180b127}/python_sdk_remote.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.180b126
+Version: 0.0.180b127
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles
@@ -22,4 +22,4 @@ Dynamic: home-page
 Dynamic: requires-dist
 Dynamic: summary
 
-This is a package for sharing common functions used in different repositories
+This is a package for sharing common functions used in different repositories.

{python_sdk_remote-0.0.180b126 → python_sdk_remote-0.0.180b127}/python_sdk_remote.egg-info/SOURCES.txt

@@ -10,7 +10,8 @@ python_sdk_remote/src/__init__.py
 python_sdk_remote/src/constants.py
 python_sdk_remote/src/constants_src_mini_logger_and_logger.py
 python_sdk_remote/src/datetime_range.py
-python_sdk_remote/src/exceptions.py
+python_sdk_remote/src/environment_variable_exception.py
+python_sdk_remote/src/filename.py
 python_sdk_remote/src/generic_crud.py
 python_sdk_remote/src/http_response.py
 python_sdk_remote/src/is_test_data.py

{python_sdk_remote-0.0.180b126 → python_sdk_remote-0.0.180b127}/setup.py

@@ -7,11 +7,11 @@ package_dir = PACKAGE_NAME.replace("-", "_")
 # python -m build needs pyproject.toml or setup.py
 setuptools.setup(
     name=PACKAGE_NAME,
-    version='0.0.180b126',  # https://pypi.org/project/python-sdk-remote#history
+    version='0.0.180b127',  # https://pypi.org/project/python-sdk-remote#history
     author="Circles",
     author_email="info@circlez.ai",
     description="PyPI Package for Circles Python SDK Local Python",
-    long_description="This is a package for sharing common functions used in different repositories",
+    long_description="This is a package for sharing common functions used in different repositories.",
     long_description_content_type="text/markdown",
     url=f"https://github.com/circles-zone/{PACKAGE_NAME}-python-package",
     packages=[package_dir],
@@ -30,7 +30,7 @@ setuptools.setup(
         "pyjwt",
         # OurObject lives here now. item.py and __init__.py import it from this
         # package directly; our_object.py is a temporary deprecated re-export kept
-        # for consumers still on `from python_sdk_remote.our_object import OurObject`.
+        # for consumers still on `from python_sdk_remote.our_object import OurObject.
         "our-object-local",
     ]
 )