python-sdk-remote 0.0.182__py3-none-any.whl → 0.0.183b1__py3-none-any.whl

python_sdk_remote/{exceptions.py → 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/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/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.182.dist-info → python_sdk_remote-0.0.183b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.182
+Version: 0.0.183b1
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles

{python_sdk_remote-0.0.182.dist-info → python_sdk_remote-0.0.183b1.dist-info}/RECORD

@@ -2,7 +2,8 @@ python_sdk_remote/__init__.py,sha256=wBfMpAOPwxDMD4wdG74B5OboGVmC_fKGlEid4p8iAeY
 python_sdk_remote/constants.py,sha256=UBJta5-UdA1Y-owTesMB4TMht-ZvHApYwXAG8EtL6uE,1372
 python_sdk_remote/constants_src_mini_logger_and_logger.py,sha256=EB9-UIX-YRfLcFCT1VianrngcoTso397gF07a3WM3zk,437
 python_sdk_remote/datetime_range.py,sha256=5dCA6vSTnqp6pnd5exEVsmbeWpaee-oxfG0cE21eW_k,4376
-python_sdk_remote/exceptions.py,sha256=N4eiN-ijGW3hBOp6AnMy28NH_Ekbtu57b6ZcqzofkVw,347
+python_sdk_remote/environment_variable_exception.py,sha256=kqLZmNT8yfPq-eWUSZvZPBY3sGsSH-igmbqa5EN9PDA,287
+python_sdk_remote/filename.py,sha256=9pqqzCehZj2NIbiqkmij2pruOtdMb08JDX6ldrJ-olY,3054
 python_sdk_remote/generic_crud.py,sha256=jzmR27kr8Pnf4Gk90SKoxbM5ufLsOr2ofekRtcHw248,9907
 python_sdk_remote/http_response.py,sha256=T659q_iPt8SkT8k-T4ZfRy9VSh0uvHyluecqwZnhRqI,12888
 python_sdk_remote/is_test_data.py,sha256=ZVu7ylFMV2FO0w0Huxqo5AXyZZ8GwbqJn3bWMRVR5ZE,110
@@ -16,11 +17,11 @@ python_sdk_remote/our_objects_remote.py,sha256=fdgZwA8DaNA5G3thdUTCj7TRrO6xpqxvR
 python_sdk_remote/our_request.py,sha256=gPN0dM_CiMzjd3vl6rl1ShJpewBlDwdIREcd4-5j3kc,14132
 python_sdk_remote/our_request_old.py,sha256=eu0LqvjrhZMT9BHU67etg-iKOnC_MaGbSDq2hT3kfVM,13591
 python_sdk_remote/unified_json.py,sha256=AmeUzBsQh2N9z9XRo1Aya5qPvcV8dzRa4-O2jlCdaTg,1242
-python_sdk_remote/utilities.py,sha256=1nlrE6FXVIdQDtLmF7IR935D6HMKoXIdp5vXRu6t_sY,24305
+python_sdk_remote/utilities.py,sha256=2iQQvUmwyez-bSKB1jTCtpHlt7TISdAAfmO2IlSrf94,24325
 python_sdk_remote/valid_json_versions.py,sha256=zVtvhsEDKkfK3o8crdcP6YWjLnzh-OykWGPT7vghb6k,147
 python_sdk_remote/validate_environment.py,sha256=VQKta418TmJwkUGXp0Rorhy65YANoNVgg86BIYPf2Wc,2321
 python_sdk_remote/version.py,sha256=nJV1jCPXMEluCrvcEBWwM8BS6DzFTv7pULfqjGXs3uA,421
-python_sdk_remote-0.0.182.dist-info/METADATA,sha256=eSy6qmQiRT7EHVZ7C_IgiEqtSb0BHoNDegL0hmfF-aY,762
-python_sdk_remote-0.0.182.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_sdk_remote-0.0.182.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
-python_sdk_remote-0.0.182.dist-info/RECORD,,
+python_sdk_remote-0.0.183b1.dist-info/METADATA,sha256=R8CKTluT0HDRhahxjskNR6sVOVon-LZtQsSsOGGZOQs,764
+python_sdk_remote-0.0.183b1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_sdk_remote-0.0.183b1.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
+python_sdk_remote-0.0.183b1.dist-info/RECORD,,