localstack-core 4.14.1.dev25__tar.gz → 4.14.1.dev26__tar.gz

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: localstack-core
-Version: 4.14.1.dev25
+Version: 4.14.1.dev26
 Summary: The core library and runtime of LocalStack
 Author-email: LocalStack Contributors <info@localstack.cloud>
 License-Expression: Apache-2.0

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/localstack/utils/bootstrap.py

@@ -445,7 +445,7 @@ def validate_localstack_config(name: str):
     return False
 
 
-def get_docker_image_to_start():
+def get_docker_image_to_start() -> str:
     image_name = os.environ.get("IMAGE_NAME")
     if not image_name:
         image_name = constants.DOCKER_IMAGE_NAME

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/localstack/utils/collections.py

@@ -15,6 +15,7 @@ from typing import (
     cast,
     get_args,
     get_origin,
+    overload,
 )
 
 import cachetools
@@ -314,7 +315,15 @@ def is_list_or_tuple(obj) -> bool:
     return isinstance(obj, (list, tuple))
 
 
-def ensure_list(obj: Any, wrap_none=False) -> list | None:
+@overload
+def ensure_list(obj: None) -> None: ...
+
+
+@overload
+def ensure_list(obj: Any) -> list[Any]: ...
+
+
+def ensure_list(obj: Any, wrap_none: bool = False) -> list[Any] | None:
     """Wrap the given object in a list, or return the object itself if it already is a list."""
     if obj is None and not wrap_none:
         return obj

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/localstack/utils/container_utils/docker_sdk_client.py

@@ -59,7 +59,7 @@ class SdkDockerClient(ContainerClient):
 
     docker_client: DockerClient | None
 
-    def __init__(self):
+    def __init__(self) -> None:
         try:
             self.docker_client = self._create_client()
             logging.getLogger("urllib3").setLevel(logging.INFO)

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/localstack/utils/docker_utils.py

@@ -94,7 +94,7 @@ def get_default_volume_dir_mount() -> VolumeInfo | None:
     return None
 
 
-def get_host_path_for_path_in_docker(path):
+def get_host_path_for_path_in_docker(path: str) -> str:
     """
     Returns the calculated host location for a given subpath of DEFAULT_VOLUME_DIR inside the localstack container.
     The path **has** to be a subdirectory of DEFAULT_VOLUME_DIR (the dir itself *will not* work).
@@ -141,8 +141,7 @@ def container_ports_can_be_bound(
     :return: True iff all ports can be bound
     """
     port_mappings = PortMappings(bind_host=address or "")
-    ports = ensure_list(ports)
-    for port in ports:
+    for port in ensure_list(ports):
         port = Port.wrap(port)
         port_mappings.add(port.port, port.port, protocol=port.protocol)
     try:
@@ -189,7 +188,7 @@ def is_port_available_for_containers(port: IntOrPort) -> bool:
     return not is_container_port_reserved(port) and container_ports_can_be_bound(port)
 
 
-def reserve_container_port(port: IntOrPort, duration: int = None):
+def reserve_container_port(port: IntOrPort, duration: int | None = None) -> None:
     """Reserve the given container port for a short period of time"""
     reserved_docker_ports.reserve_port(port, duration=duration)
 
@@ -201,10 +200,10 @@ def is_container_port_reserved(port: IntOrPort) -> bool:
 
 
 def reserve_available_container_port(
-    duration: int = None,
-    port_start: int = None,
-    port_end: int = None,
-    protocol: str = None,
+    duration: int | None = None,
+    port_start: int | None = None,
+    port_end: int | None = None,
+    protocol: str | None = None,
 ) -> int:
     """
     Determine a free port within the given port range that can be bound by a Docker container, and reserve
@@ -220,7 +219,7 @@ def reserve_available_container_port(
 
     protocol = protocol or "tcp"
 
-    def _random_port():
+    def _random_port() -> Port:
         port = None
         while not port or reserved_docker_ports.is_port_reserved(port):
             port_number = random.randint(
@@ -263,7 +262,7 @@ def _get_ports_check_docker_image() -> str:
     try:
         # inspect the running container to determine the image
         container = DOCKER_CLIENT.inspect_container(get_current_container_id())
-        return container["Config"]["Image"]
+        return container["Config"]["Image"]  # type: ignore[index]
     except Exception:
         # fall back to using the default Docker image
         return DOCKER_IMAGE_NAME

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/localstack/utils/files.py

@@ -1,24 +1,36 @@
 import configparser
-import inspect
 import logging
 import os
 import shutil
 import stat
 import tempfile
 from pathlib import Path
+from typing import Any, AnyStr, Literal, overload
 
 LOG = logging.getLogger(__name__)
-TMP_FILES = []
+TMP_FILES: list[str] = []
 
 
-def parse_config_file(file_or_str: str, single_section: bool = True) -> dict:
+@overload
+def parse_config_file(file_or_str: str, single_section: Literal[True]) -> dict[str, str]: ...
+
+
+@overload
+def parse_config_file(
+    file_or_str: str, single_section: Literal[False]
+) -> dict[str, dict[str, str]]: ...
+
+
+def parse_config_file(
+    file_or_str: str, single_section: bool = True
+) -> dict[str, str] | dict[str, dict[str, str]]:
     """Parse the given properties config file/string and return a dict of section->key->value.
     If the config contains a single section, and 'single_section' is True, returns"""
 
     config = configparser.RawConfigParser()
 
     if os.path.exists(file_or_str):
-        file_or_str = load_file(file_or_str)
+        file_or_str = load_file(file_or_str)  # type: ignore[assignment]
 
     try:
         config.read_string(file_or_str)
@@ -30,7 +42,7 @@ def parse_config_file(file_or_str: str, single_section: bool = True) -> dict:
 
     result = {sec: dict(config.items(sec)) for sec in sections}
     if len(sections) == 1 and single_section:
-        result = result[sections[0]]
+        return result[sections[0]]
 
     return result
 
@@ -64,13 +76,18 @@ def cache_dir() -> Path:
     return get_user_cache_dir() / "localstack"
 
 
-def save_file(file, content, append=False, permissions=None):
+def save_file(
+    file: str | os.PathLike[AnyStr],
+    content: str | bytes,
+    append: bool = False,
+    permissions: int | None = None,
+) -> None:
     mode = "a" if append else "w+"
     if not isinstance(content, str):
         mode = mode + "b"
 
-    def _opener(path, flags):
-        return os.open(path, flags, permissions)
+    def _opener(path: str, flags: int) -> int:
+        return os.open(path, flags, permissions)  # type: ignore[arg-type]
 
     # make sure that the parent dir exists
     mkdir(os.path.dirname(file))
@@ -80,8 +97,35 @@ def save_file(file, content, append=False, permissions=None):
         f.flush()
 
 
+@overload
 def load_file(
-    file_path: str | os.PathLike,
+    file_path: str | os.PathLike[AnyStr],
+    default: None = None,
+    mode: None = None,
+    strict: bool = False,
+) -> str | None: ...
+
+
+@overload
+def load_file(
+    file_path: str | os.PathLike[AnyStr],
+    default: str,
+    mode: None = None,
+    strict: bool = False,
+) -> str | None: ...
+
+
+@overload
+def load_file(
+    file_path: str | os.PathLike[AnyStr],
+    default: bytes,
+    mode: Literal["rb"],
+    strict: bool = False,
+) -> bytes | None: ...
+
+
+def load_file(
+    file_path: str | os.PathLike[AnyStr],
     default: str | bytes | None = None,
     mode: str | None = None,
     strict: bool = False,
@@ -107,7 +151,11 @@ def load_file(
     return result
 
 
-def get_or_create_file(file_path, content=None, permissions=None):
+def get_or_create_file(
+    file_path: os.PathLike[AnyStr],
+    content: str | bytes | None = None,
+    permissions: int | None = None,
+) -> str | bytes | None:
     if os.path.exists(file_path):
         return load_file(file_path)
     content = "{}" if content is None else content
@@ -116,9 +164,10 @@ def get_or_create_file(file_path, content=None, permissions=None):
         return content
     except Exception:
         pass
+    return None
 
 
-def replace_in_file(search, replace, file_path):
+def replace_in_file(search: str, replace: str, file_path: os.PathLike[AnyStr]) -> None:
     """Replace all occurrences of `search` with `replace` in the given file (overwrites in place!)"""
     content = load_file(file_path) or ""
     content_new = content.replace(search, replace)
@@ -126,7 +175,7 @@ def replace_in_file(search, replace, file_path):
         save_file(file_path, content_new)
 
 
-def mkdir(folder: str):
+def mkdir(folder: str | bytes | os.PathLike[AnyStr]) -> None:
     if not os.path.exists(folder):
         os.makedirs(folder, exist_ok=True)
 
@@ -142,7 +191,7 @@ def is_empty_dir(directory: str, ignore_hidden: bool = False) -> bool:
     return not bool(entries)
 
 
-def ensure_readable(file_path: str, default_perms: int = None):
+def ensure_readable(file_path: str, default_perms: int | None = None) -> None:
     if default_perms is None:
         default_perms = 0o644
     try:
@@ -153,7 +202,7 @@ def ensure_readable(file_path: str, default_perms: int = None):
         os.chmod(file_path, default_perms)
 
 
-def chown_r(path: str, user: str):
+def chown_r(path: str, user: str) -> None:
     """Recursive chown on the given file/directory path."""
     # keep these imports here for Windows compatibility
     import grp
@@ -169,7 +218,7 @@ def chown_r(path: str, user: str):
             os.chown(os.path.join(root, filename), uid, gid)
 
 
-def chmod_r(path: str, mode: int):
+def chmod_r(path: str, mode: int) -> None:
     """
     Recursive chmod
     :param path: path to file or directory
@@ -185,7 +234,7 @@ def chmod_r(path: str, mode: int):
             idempotent_chmod(os.path.join(root, filename), mode)
 
 
-def idempotent_chmod(path: str, mode: int):
+def idempotent_chmod(path: str, mode: int) -> None:
     """
     Perform idempotent chmod on the given file path (non-recursively). The function attempts to call `os.chmod`, and
     will catch and only re-raise exceptions (e.g., PermissionError) if the file does not have the given mode already.
@@ -206,7 +255,7 @@ def idempotent_chmod(path: str, mode: int):
         raise
 
 
-def rm_rf(path: str):
+def rm_rf(path: str) -> None:
     """
     Recursively removes a file or directory
     """
@@ -218,7 +267,7 @@ def rm_rf(path: str):
     # Running the native command can be an order of magnitude faster in Alpine on Travis-CI
     if is_debian():
         try:
-            return run(f'rm -rf "{path}"')
+            return run(f'rm -rf "{path}"')  # type: ignore[return-value]
         except Exception:
             pass
     # Make sure all files are writeable and dirs executable to remove
@@ -234,13 +283,15 @@ def rm_rf(path: str):
         shutil.rmtree(path)
 
 
-def cp_r(src: str, dst: str, rm_dest_on_conflict=False, ignore_copystat_errors=False, **kwargs):
+def cp_r(
+    src: str, dst: str, rm_dest_on_conflict: bool = False, ignore_copystat_errors: bool = False
+) -> None | str:
     """Recursively copies file/directory"""
     # attention: this patch is not threadsafe
     copystat_orig = shutil.copystat
     if ignore_copystat_errors:
 
-        def _copystat(*args, **kwargs):
+        def _copystat(*args: Any, **kwargs: Any) -> None:
             try:
                 return copystat_orig(*args, **kwargs)
             except Exception:
@@ -252,21 +303,19 @@ def cp_r(src: str, dst: str, rm_dest_on_conflict=False, ignore_copystat_errors=F
             if os.path.isdir(dst):
                 dst = os.path.join(dst, os.path.basename(src))
             return shutil.copyfile(src, dst)
-        if "dirs_exist_ok" in inspect.getfullargspec(shutil.copytree).args:
-            kwargs["dirs_exist_ok"] = True
         try:
-            return shutil.copytree(src, dst, **kwargs)
+            return shutil.copytree(src, dst, dirs_exist_ok=True)
         except FileExistsError:
             if rm_dest_on_conflict:
                 rm_rf(dst)
-                return shutil.copytree(src, dst, **kwargs)
+                return shutil.copytree(src, dst, dirs_exist_ok=True)
             raise
     except Exception as e:
 
-        def _info(_path):
+        def _info(_path: str) -> str:
             return f"{_path} (file={os.path.isfile(_path)}, symlink={os.path.islink(_path)})"
 
-        LOG.debug("Error copying files from %s to %s: %s", _info(src), _info(dst), e)
+        LOG.debug("Error copying files from %s to %s", _info(src), _info(dst), e)
         raise
     finally:
         shutil.copystat = copystat_orig
@@ -293,10 +342,10 @@ def disk_usage(path: str) -> int:
 
 def file_exists_not_empty(path: str) -> bool:
     """Return whether the given file or directory exists and is non-empty (i.e., >0 bytes content)"""
-    return path and disk_usage(path) > 0
+    return bool(path) and disk_usage(path) > 0
 
 
-def cleanup_tmp_files():
+def cleanup_tmp_files() -> None:
     for tmp in TMP_FILES:
         try:
             rm_rf(tmp)

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/localstack/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '4.14.1.dev25'
-__version_tuple__ = version_tuple = (4, 14, 1, 'dev25')
+__version__ = version = '4.14.1.dev26'
+__version_tuple__ = version_tuple = (4, 14, 1, 'dev26')
 
-__commit_id__ = commit_id = 'g9642b8ece'
+__commit_id__ = commit_id = 'g1c66dc029'

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/localstack_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: localstack-core
-Version: 4.14.1.dev25
+Version: 4.14.1.dev26
 Summary: The core library and runtime of LocalStack
 Author-email: LocalStack Contributors <info@localstack.cloud>
 License-Expression: Apache-2.0

{localstack_core-4.14.1.dev25 → localstack_core-4.14.1.dev26}/localstack-core/mypy.ini

@@ -1,7 +1,7 @@
 [mypy]
 explicit_package_bases = true
 mypy_path=localstack-core
-files=localstack/aws/api/core.py,localstack/utils/threads.py,localstack/utils/strings.py,localstack/packages,localstack/services/transcribe,localstack/services/kinesis/packages.py
+files=localstack/aws/api/core.py,localstack/utils/files.py,localstack/utils/docker_utils.py,localstack/utils/threads.py,localstack/utils/strings.py,localstack/packages,localstack/services/transcribe,localstack/services/kinesis/packages.py
 ignore_missing_imports = False
 follow_imports = silent
 ignore_errors = False