nimble_python 0.16.0__tar.gz → 0.17.0__tar.gz

nimble_python-0.17.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.17.0"
+}

{nimble_python-0.16.0 → nimble_python-0.17.0}/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## 0.17.0 (2026-05-06)
+
+Full Changelog: [v0.16.0...v0.17.0](https://github.com/Nimbleway/nimble-python/compare/v0.16.0...v0.17.0)
+
+### Features
+
+* **api:** api update ([d859e62](https://github.com/Nimbleway/nimble-python/commit/d859e62068214303e9430d093a78028b25b854a2))
+* **api:** api update ([da41c63](https://github.com/Nimbleway/nimble-python/commit/da41c63037e82fde7af3a3e0da8cb3782a175bb8))
+* **api:** api update ([3460f38](https://github.com/Nimbleway/nimble-python/commit/3460f38ecdf277bbebf2fdc7104015d4a7fee810))
+* **api:** api update ([0809fc4](https://github.com/Nimbleway/nimble-python/commit/0809fc473463e746e5b1af30cfcadbfc87db7a5e))
+* **client:** add client_source parameter, update press_action types ([346cfe7](https://github.com/Nimbleway/nimble-python/commit/346cfe70ff7a237c9f0bd52ae699d2012cf5cec7))
+* support setting headers via env ([74b98e0](https://github.com/Nimbleway/nimble-python/commit/74b98e0af4a71cedc34d53f4b33efd6126b91439))
+
+
+### Bug Fixes
+
+* **client:** preserve hardcoded query params when merging with user params ([c07dd33](https://github.com/Nimbleway/nimble-python/commit/c07dd33a98b0dc7a365153ebe13aa8e4f41035fc))
+* ensure file data are only sent as 1 parameter ([58d7d07](https://github.com/Nimbleway/nimble-python/commit/58d7d07475836f0d4ce1c4f68bba7e3631e68d34))
+* use correct field name format for multipart file arrays ([d33d6b7](https://github.com/Nimbleway/nimble-python/commit/d33d6b7599d29d0508fa14ba03a8e0eb7c756aad))
+
+
+### Performance Improvements
+
+* **client:** optimize file structure copying in multipart requests ([77a1d14](https://github.com/Nimbleway/nimble-python/commit/77a1d14ebc143548bcca089d281babc094e01a7e))
+
+
+### Chores
+
+* **internal:** more robust bootstrap script ([ea52394](https://github.com/Nimbleway/nimble-python/commit/ea52394a5adbf1ef83a2d0a5b378d7feb0e0a5f8))
+* **internal:** reformat pyproject.toml ([7d5cec6](https://github.com/Nimbleway/nimble-python/commit/7d5cec6274e237ab69a2b32e79f72a9baad78fff))
+
+
+### Documentation
+
+* improve examples ([a86f0ef](https://github.com/Nimbleway/nimble-python/commit/a86f0ef01987c3063ab465d4ab61bd04229a4911))
+
 ## 0.16.0 (2026-03-30)
 
 Full Changelog: [v0.15.0...v0.16.0](https://github.com/Nimbleway/nimble-python/compare/v0.15.0...v0.16.0)

{nimble_python-0.16.0 → nimble_python-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nimble_python
-Version: 0.16.0
+Version: 0.17.0
 Summary: The official Python library for the nimble API
 Project-URL: Homepage, https://github.com/Nimbleway/nimble-python
 Project-URL: Repository, https://github.com/Nimbleway/nimble-python

{nimble_python-0.16.0 → nimble_python-0.17.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nimble_python"
-version = "0.16.0"
+version = "0.17.0"
 description = "The official Python library for the nimble API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -154,7 +154,7 @@ show_error_codes = true
 #
 # We also exclude our `tests` as mypy doesn't always infer
 # types correctly and Pyright will still catch any type errors.
-exclude = ['src/nimble_python/_files.py', '_dev/.*.py', 'tests/.*']
+exclude = ["src/nimble_python/_files.py", "_dev/.*.py", "tests/.*"]
 
 strict_equality = true
 implicit_reexport = true

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_base_client.py

@@ -540,6 +540,10 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
                 files = cast(HttpxRequestFiles, ForceMultipartDict())
 
         prepared_url = self._prepare_url(options.url)
+        # preserve hard-coded query params from the url
+        if params and prepared_url.query:
+            params = {**dict(prepared_url.params.items()), **params}
+            prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0])
         if "_" in prepared_url.host:
             # work around https://github.com/encode/httpx/discussions/2880
             kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")}

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_client.py

@@ -33,6 +33,7 @@ from ._types import (
 )
 from ._utils import (
     is_given,
+    is_mapping_t,
     maybe_transform,
     get_async_library,
     async_maybe_transform,
@@ -72,11 +73,13 @@ __all__ = ["Timeout", "Transport", "ProxiesTypes", "RequestOptions", "Nimble", "
 class Nimble(SyncAPIClient):
     # client options
     api_key: str | None
+    client_source: str | None
 
     def __init__(
         self,
         *,
         api_key: str | None = None,
+        client_source: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -98,17 +101,32 @@ class Nimble(SyncAPIClient):
     ) -> None:
         """Construct a new synchronous Nimble client instance.
 
-        This automatically infers the `api_key` argument from the `NIMBLE_API_KEY` environment variable if it is not provided.
+        This automatically infers the following arguments from their corresponding environment variables if they are not provided:
+        - `api_key` from `NIMBLE_API_KEY`
+        - `client_source` from `CLIENT_SOURCE`
         """
         if api_key is None:
             api_key = os.environ.get("NIMBLE_API_KEY")
         self.api_key = api_key
 
+        if client_source is None:
+            client_source = os.environ.get("CLIENT_SOURCE") or "sdk"
+        self.client_source = client_source
+
         if base_url is None:
             base_url = os.environ.get("NIMBLE_BASE_URL")
         if base_url is None:
             base_url = f"https://sdk.nimbleway.com"
 
+        custom_headers_env = os.environ.get("NIMBLE_CUSTOM_HEADERS")
+        if custom_headers_env is not None:
+            parsed: dict[str, str] = {}
+            for line in custom_headers_env.split("\n"):
+                colon = line.find(":")
+                if colon >= 0:
+                    parsed[line[:colon].strip()] = line[colon + 1 :].strip()
+            default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})}
+
         super().__init__(
             version=__version__,
             base_url=base_url,
@@ -171,6 +189,7 @@ class Nimble(SyncAPIClient):
         return {
             **super().default_headers,
             "X-Stainless-Async": "false",
+            "X-Client-Source": self.client_source if self.client_source is not None else Omit(),
             **self._custom_headers,
         }
 
@@ -187,6 +206,7 @@ class Nimble(SyncAPIClient):
         self,
         *,
         api_key: str | None = None,
+        client_source: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.Client | None = None,
@@ -221,6 +241,7 @@ class Nimble(SyncAPIClient):
         http_client = http_client or self._client
         return self.__class__(
             api_key=api_key or self.api_key,
+            client_source=client_source or self.client_source,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -498,9 +519,9 @@ class Nimble(SyncAPIClient):
         ]
         | Omit = omit,
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
-        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
+        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro", "media-vx6"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers", "links"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -1040,6 +1061,7 @@ class Nimble(SyncAPIClient):
             "auto",
         ]
         | Omit = omit,
+        markdown_backend: Literal["full_page", "main_content"] | Omit = omit,
         method: Literal["GET", "POST", "PUT", "PATCH", "DELETE"] | Omit = omit,
         network_capture: Iterable[client_extract_params.NetworkCapture] | Omit = omit,
         os: Literal["windows", "mac os", "linux", "android", "ios"] | Omit = omit,
@@ -1154,6 +1176,10 @@ class Nimble(SyncAPIClient):
 
           locale: Locale for browser language and region settings
 
+          markdown_backend: Selects which markdown conversion strategy to use. "full_page" converts the
+              entire HTML page. "main_content" uses Mozilla Readability to extract the main
+              article content before converting.
+
           method: HTTP method for the request
 
           network_capture: Filters for capturing network traffic
@@ -1203,6 +1229,7 @@ class Nimble(SyncAPIClient):
                     "http2": http2,
                     "is_xhr": is_xhr,
                     "locale": locale,
+                    "markdown_backend": markdown_backend,
                     "method": method,
                     "network_capture": network_capture,
                     "os": os,
@@ -1489,9 +1516,9 @@ class Nimble(SyncAPIClient):
         ]
         | Omit = omit,
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
-        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
+        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro", "media-vx6"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers", "links"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -2031,6 +2058,7 @@ class Nimble(SyncAPIClient):
             "auto",
         ]
         | Omit = omit,
+        markdown_backend: Literal["full_page", "main_content"] | Omit = omit,
         method: Literal["GET", "POST", "PUT", "PATCH", "DELETE"] | Omit = omit,
         network_capture: Iterable[client_extract_async_params.NetworkCapture] | Omit = omit,
         os: Literal["windows", "mac os", "linux", "android", "ios"] | Omit = omit,
@@ -2151,6 +2179,10 @@ class Nimble(SyncAPIClient):
 
           locale: Locale for browser language and region settings
 
+          markdown_backend: Selects which markdown conversion strategy to use. "full_page" converts the
+              entire HTML page. "main_content" uses Mozilla Readability to extract the main
+              article content before converting.
+
           method: HTTP method for the request
 
           network_capture: Filters for capturing network traffic
@@ -2209,6 +2241,7 @@ class Nimble(SyncAPIClient):
                     "http2": http2,
                     "is_xhr": is_xhr,
                     "locale": locale,
+                    "markdown_backend": markdown_backend,
                     "method": method,
                     "network_capture": network_capture,
                     "os": os,
@@ -3272,11 +3305,13 @@ class Nimble(SyncAPIClient):
 class AsyncNimble(AsyncAPIClient):
     # client options
     api_key: str | None
+    client_source: str | None
 
     def __init__(
         self,
         *,
         api_key: str | None = None,
+        client_source: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -3298,17 +3333,32 @@ class AsyncNimble(AsyncAPIClient):
     ) -> None:
         """Construct a new async AsyncNimble client instance.
 
-        This automatically infers the `api_key` argument from the `NIMBLE_API_KEY` environment variable if it is not provided.
+        This automatically infers the following arguments from their corresponding environment variables if they are not provided:
+        - `api_key` from `NIMBLE_API_KEY`
+        - `client_source` from `CLIENT_SOURCE`
         """
         if api_key is None:
             api_key = os.environ.get("NIMBLE_API_KEY")
         self.api_key = api_key
 
+        if client_source is None:
+            client_source = os.environ.get("CLIENT_SOURCE") or "sdk"
+        self.client_source = client_source
+
         if base_url is None:
             base_url = os.environ.get("NIMBLE_BASE_URL")
         if base_url is None:
             base_url = f"https://sdk.nimbleway.com"
 
+        custom_headers_env = os.environ.get("NIMBLE_CUSTOM_HEADERS")
+        if custom_headers_env is not None:
+            parsed: dict[str, str] = {}
+            for line in custom_headers_env.split("\n"):
+                colon = line.find(":")
+                if colon >= 0:
+                    parsed[line[:colon].strip()] = line[colon + 1 :].strip()
+            default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})}
+
         super().__init__(
             version=__version__,
             base_url=base_url,
@@ -3371,6 +3421,7 @@ class AsyncNimble(AsyncAPIClient):
         return {
             **super().default_headers,
             "X-Stainless-Async": f"async:{get_async_library()}",
+            "X-Client-Source": self.client_source if self.client_source is not None else Omit(),
             **self._custom_headers,
         }
 
@@ -3387,6 +3438,7 @@ class AsyncNimble(AsyncAPIClient):
         self,
         *,
         api_key: str | None = None,
+        client_source: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.AsyncClient | None = None,
@@ -3421,6 +3473,7 @@ class AsyncNimble(AsyncAPIClient):
         http_client = http_client or self._client
         return self.__class__(
             api_key=api_key or self.api_key,
+            client_source=client_source or self.client_source,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -3698,9 +3751,9 @@ class AsyncNimble(AsyncAPIClient):
         ]
         | Omit = omit,
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
-        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
+        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro", "media-vx6"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers", "links"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -4240,6 +4293,7 @@ class AsyncNimble(AsyncAPIClient):
             "auto",
         ]
         | Omit = omit,
+        markdown_backend: Literal["full_page", "main_content"] | Omit = omit,
         method: Literal["GET", "POST", "PUT", "PATCH", "DELETE"] | Omit = omit,
         network_capture: Iterable[client_extract_params.NetworkCapture] | Omit = omit,
         os: Literal["windows", "mac os", "linux", "android", "ios"] | Omit = omit,
@@ -4354,6 +4408,10 @@ class AsyncNimble(AsyncAPIClient):
 
           locale: Locale for browser language and region settings
 
+          markdown_backend: Selects which markdown conversion strategy to use. "full_page" converts the
+              entire HTML page. "main_content" uses Mozilla Readability to extract the main
+              article content before converting.
+
           method: HTTP method for the request
 
           network_capture: Filters for capturing network traffic
@@ -4403,6 +4461,7 @@ class AsyncNimble(AsyncAPIClient):
                     "http2": http2,
                     "is_xhr": is_xhr,
                     "locale": locale,
+                    "markdown_backend": markdown_backend,
                     "method": method,
                     "network_capture": network_capture,
                     "os": os,
@@ -4689,9 +4748,9 @@ class AsyncNimble(AsyncAPIClient):
         ]
         | Omit = omit,
         device: Literal["desktop", "mobile", "tablet"] | Omit = omit,
-        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"] | Omit = omit,
+        driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro", "media-vx6"] | Omit = omit,
         expected_status_codes: Iterable[int] | Omit = omit,
-        formats: List[Literal["html", "markdown", "screenshot", "headers"]] | Omit = omit,
+        formats: List[Literal["html", "markdown", "screenshot", "headers", "links"]] | Omit = omit,
         headers: Dict[str, Union[str, SequenceNotStr[str], None]] | Omit = omit,
         http2: bool | Omit = omit,
         is_xhr: bool | Omit = omit,
@@ -5231,6 +5290,7 @@ class AsyncNimble(AsyncAPIClient):
             "auto",
         ]
         | Omit = omit,
+        markdown_backend: Literal["full_page", "main_content"] | Omit = omit,
         method: Literal["GET", "POST", "PUT", "PATCH", "DELETE"] | Omit = omit,
         network_capture: Iterable[client_extract_async_params.NetworkCapture] | Omit = omit,
         os: Literal["windows", "mac os", "linux", "android", "ios"] | Omit = omit,
@@ -5351,6 +5411,10 @@ class AsyncNimble(AsyncAPIClient):
 
           locale: Locale for browser language and region settings
 
+          markdown_backend: Selects which markdown conversion strategy to use. "full_page" converts the
+              entire HTML page. "main_content" uses Mozilla Readability to extract the main
+              article content before converting.
+
           method: HTTP method for the request
 
           network_capture: Filters for capturing network traffic
@@ -5409,6 +5473,7 @@ class AsyncNimble(AsyncAPIClient):
                     "http2": http2,
                     "is_xhr": is_xhr,
                     "locale": locale,
+                    "markdown_backend": markdown_backend,
                     "method": method,
                     "network_capture": network_capture,
                     "os": os,

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_files.py

@@ -3,8 +3,8 @@ from __future__ import annotations
 import io
 import os
 import pathlib
-from typing import overload
-from typing_extensions import TypeGuard
+from typing import Sequence, cast, overload
+from typing_extensions import TypeVar, TypeGuard
 
 import anyio
 
@@ -17,7 +17,9 @@ from ._types import (
     HttpxFileContent,
     HttpxRequestFiles,
 )
-from ._utils import is_tuple_t, is_mapping_t, is_sequence_t
+from ._utils import is_list, is_mapping, is_tuple_t, is_mapping_t, is_sequence_t
+
+_T = TypeVar("_T")
 
 
 def is_base64_file_input(obj: object) -> TypeGuard[Base64FileInput]:
@@ -121,3 +123,51 @@ async def async_read_file_content(file: FileContent) -> HttpxFileContent:
         return await anyio.Path(file).read_bytes()
 
     return file
+
+
+def deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]]) -> _T:
+    """Copy only the containers along the given paths.
+
+    Used to guard against mutation by extract_files without copying the entire structure.
+    Only dicts and lists that lie on a path are copied; everything else
+    is returned by reference.
+
+    For example, given paths=[["foo", "files", "file"]] and the structure:
+        {
+            "foo": {
+                "bar": {"baz": {}},
+                "files": {"file": <content>}
+            }
+        }
+    The root dict, "foo", and "files" are copied (they lie on the path).
+    "bar" and "baz" are returned by reference (off the path).
+    """
+    return _deepcopy_with_paths(item, paths, 0)
+
+
+def _deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]], index: int) -> _T:
+    if not paths:
+        return item
+    if is_mapping(item):
+        key_to_paths: dict[str, list[Sequence[str]]] = {}
+        for path in paths:
+            if index < len(path):
+                key_to_paths.setdefault(path[index], []).append(path)
+
+        # if no path continues through this mapping, it won't be mutated and copying it is redundant
+        if not key_to_paths:
+            return item
+
+        result = dict(item)
+        for key, subpaths in key_to_paths.items():
+            if key in result:
+                result[key] = _deepcopy_with_paths(result[key], subpaths, index + 1)
+        return cast(_T, result)
+    if is_list(item):
+        array_paths = [path for path in paths if index < len(path) and path[index] == "<array>"]
+
+        # if no path expects a list here, nothing will be mutated inside it - return by reference
+        if not array_paths:
+            return cast(_T, item)
+        return cast(_T, [_deepcopy_with_paths(entry, array_paths, index + 1) for entry in item])
+    return item

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_qs.py

@@ -2,17 +2,13 @@ from __future__ import annotations
 
 from typing import Any, List, Tuple, Union, Mapping, TypeVar
 from urllib.parse import parse_qs, urlencode
-from typing_extensions import Literal, get_args
+from typing_extensions import get_args
 
-from ._types import NotGiven, not_given
+from ._types import NotGiven, ArrayFormat, NestedFormat, not_given
 from ._utils import flatten
 
 _T = TypeVar("_T")
 
-
-ArrayFormat = Literal["comma", "repeat", "indices", "brackets"]
-NestedFormat = Literal["dots", "brackets"]
-
 PrimitiveData = Union[str, int, float, bool, None]
 # this should be Data = Union[PrimitiveData, "List[Data]", "Tuple[Data]", "Mapping[str, Data]"]
 # https://github.com/microsoft/pyright/issues/3555

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_types.py

@@ -47,6 +47,9 @@ AnyMapping = Mapping[str, object]
 ModelT = TypeVar("ModelT", bound=pydantic.BaseModel)
 _T = TypeVar("_T")
 
+ArrayFormat = Literal["comma", "repeat", "indices", "brackets"]
+NestedFormat = Literal["dots", "brackets"]
+
 
 # Approximates httpx internal ProxiesTypes and RequestFiles types
 # while adding support for `PathLike` instances

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_utils/__init__.py

@@ -24,7 +24,6 @@ from ._utils import (
     coerce_integer as coerce_integer,
     file_from_path as file_from_path,
     strip_not_given as strip_not_given,
-    deepcopy_minimal as deepcopy_minimal,
     get_async_library as get_async_library,
     maybe_coerce_float as maybe_coerce_float,
     get_required_header as get_required_header,

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_utils/_utils.py

@@ -17,11 +17,11 @@ from typing import (
 )
 from pathlib import Path
 from datetime import date, datetime
-from typing_extensions import TypeGuard
+from typing_extensions import TypeGuard, get_args
 
 import sniffio
 
-from .._types import Omit, NotGiven, FileTypes, HeadersLike
+from .._types import Omit, NotGiven, FileTypes, ArrayFormat, HeadersLike
 
 _T = TypeVar("_T")
 _TupleT = TypeVar("_TupleT", bound=Tuple[object, ...])
@@ -40,25 +40,45 @@ def extract_files(
     query: Mapping[str, object],
     *,
     paths: Sequence[Sequence[str]],
+    array_format: ArrayFormat = "brackets",
 ) -> list[tuple[str, FileTypes]]:
     """Recursively extract files from the given dictionary based on specified paths.
 
     A path may look like this ['foo', 'files', '<array>', 'data'].
 
+    ``array_format`` controls how ``<array>`` segments contribute to the emitted
+    field name. Supported values: ``"brackets"`` (``foo[]``), ``"repeat"`` and
+    ``"comma"`` (``foo``), ``"indices"`` (``foo[0]``, ``foo[1]``).
+
     Note: this mutates the given dictionary.
     """
     files: list[tuple[str, FileTypes]] = []
     for path in paths:
-        files.extend(_extract_items(query, path, index=0, flattened_key=None))
+        files.extend(_extract_items(query, path, index=0, flattened_key=None, array_format=array_format))
     return files
 
 
+def _array_suffix(array_format: ArrayFormat, array_index: int) -> str:
+    if array_format == "brackets":
+        return "[]"
+    if array_format == "indices":
+        return f"[{array_index}]"
+    if array_format == "repeat" or array_format == "comma":
+        # Both repeat the bare field name for each file part; there is no
+        # meaningful way to comma-join binary parts.
+        return ""
+    raise NotImplementedError(
+        f"Unknown array_format value: {array_format}, choose from {', '.join(get_args(ArrayFormat))}"
+    )
+
+
 def _extract_items(
     obj: object,
     path: Sequence[str],
     *,
     index: int,
     flattened_key: str | None,
+    array_format: ArrayFormat,
 ) -> list[tuple[str, FileTypes]]:
     try:
         key = path[index]
@@ -75,9 +95,11 @@ def _extract_items(
 
         if is_list(obj):
             files: list[tuple[str, FileTypes]] = []
-            for entry in obj:
-                assert_is_file_content(entry, key=flattened_key + "[]" if flattened_key else "")
-                files.append((flattened_key + "[]", cast(FileTypes, entry)))
+            for array_index, entry in enumerate(obj):
+                suffix = _array_suffix(array_format, array_index)
+                emitted_key = (flattened_key + suffix) if flattened_key else suffix
+                assert_is_file_content(entry, key=emitted_key)
+                files.append((emitted_key, cast(FileTypes, entry)))
             return files
 
         assert_is_file_content(obj, key=flattened_key)
@@ -86,8 +108,9 @@ def _extract_items(
     index += 1
     if is_dict(obj):
         try:
-            # We are at the last entry in the path so we must remove the field
-            if (len(path)) == index:
+            # Remove the field if there are no more dict keys in the path,
+            # only "<array>" traversal markers or end.
+            if all(p == "<array>" for p in path[index:]):
                 item = obj.pop(key)
             else:
                 item = obj[key]
@@ -105,6 +128,7 @@ def _extract_items(
             path,
             index=index,
             flattened_key=flattened_key,
+            array_format=array_format,
         )
     elif is_list(obj):
         if key != "<array>":
@@ -116,9 +140,12 @@ def _extract_items(
                     item,
                     path,
                     index=index,
-                    flattened_key=flattened_key + "[]" if flattened_key is not None else "[]",
+                    flattened_key=(
+                        (flattened_key if flattened_key is not None else "") + _array_suffix(array_format, array_index)
+                    ),
+                    array_format=array_format,
                 )
-                for item in obj
+                for array_index, item in enumerate(obj)
             ]
         )
 
@@ -176,21 +203,6 @@ def is_iterable(obj: object) -> TypeGuard[Iterable[object]]:
     return isinstance(obj, Iterable)
 
 
-def deepcopy_minimal(item: _T) -> _T:
-    """Minimal reimplementation of copy.deepcopy() that will only copy certain object types:
-
-    - mappings, e.g. `dict`
-    - list
-
-    This is done for performance reasons.
-    """
-    if is_mapping(item):
-        return cast(_T, {k: deepcopy_minimal(v) for k, v in item.items()})
-    if is_list(item):
-        return cast(_T, [deepcopy_minimal(entry) for entry in item])
-    return item
-
-
 # copied from https://github.com/Rapptz/RoboDanny
 def human_join(seq: Sequence[str], *, delim: str = ", ", final: str = "or") -> str:
     size = len(seq)

{nimble_python-0.16.0 → nimble_python-0.17.0}/src/nimble_python/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "nimble_python"
-__version__ = "0.16.0"  # x-release-please-version
+__version__ = "0.17.0"  # x-release-please-version