[PYTHON] switch from mutable bytearray to immutable bytes to avoid pydantic error

[jdkent]

PR checklist

• Read the contribution guidelines.
• Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
• Run the following to build the project and update samples:

  ./mvnw clean package || exit
  ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
  ./bin/utils/export_docs_generators.sh || exit
  

  (For Windows users, please run the script in WSL)
  Commit all changed files.
  This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
  These must match the expectations made by your contribution.
  You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
  IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
• File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
• If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
• If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

---

Summary by cubic

Switch Python binary types from mutable bytearray to immutable bytes to avoid Pydantic validation errors and standardize binary handling. Updated deserialization and regenerated samples/docs.

• Bug Fixes

  • Map OpenAPI file/binary/ByteArray to bytes in PythonClientCodegen.
  • ApiClient deserializer now handles both "bytes" and "bytearray" response types.
  • Updated docs to remove bytearray from primitives and regenerated Python samples.

• Migration

  • Pass bytes instead of bytearray for binary inputs (e.g., body, files, required_file).
  • Binary responses are now typed as bytes in generated clients.

^{Written for commit c393e05. Summary will update on new commits.}

Python technical committee
@cbornet
@tomplus
@krjakbrjak
@fa0311
@multani

minimal reproducible example for the error

openapi: 3.0.3
info:
  title: Minimal Bytearray Repro
  version: 1.0.0
paths:
  /result-upload:
    get:
      operationId: getResultUpload
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/result-upload'
components:
  schemas:
    result-upload:
      type: object
      properties:
        statistical_maps:
          $ref: '#/components/schemas/result-upload-statistical-maps'
    result-upload-statistical-maps:
      oneOf:
        - type: string
          format: binary
        - type: array
          items:
            type: string
            format: binary

config.json

{
  "packageName": "min_bytearray_sdk",
  "projectName": "min-bytearray-sdk",
  "packageVersion": "0.0.1",
  "hideGenerationTimestamp": true,
  "library": "urllib3",
  "lazyImports": true
}

minimal script to test the import failure

#!/usr/bin/env python3
import argparse
import importlib
import os
import sys
import traceback


def main() -> int:
    parser = argparse.ArgumentParser(
        description="Import generated minimal SDK and show schema-generation failure."
    )
    parser.add_argument(
        "--sdk-dir",
        default="generated-stock",
        help="Path to generated SDK root (default: generated-stock)",
    )
    parser.add_argument(
        "--module",
        default="min_bytearray_sdk.models.result_upload_statistical_maps",
        help=(
            "Module path to import from generated SDK "
            "(default: min_bytearray_sdk.models.result_upload_statistical_maps)"
        ),
    )
    args = parser.parse_args()

    sdk_dir = os.path.abspath(args.sdk_dir)
    if not os.path.isdir(sdk_dir):
        print(f"SDK directory does not exist: {sdk_dir}", file=sys.stderr)
        return 2

    if sdk_dir not in sys.path:
        sys.path.insert(0, sdk_dir)

    print(f"Using sdk_dir: {sdk_dir}")
    print(f"Attempting import: {args.module}")

    try:
        importlib.import_module(args.module)
        print("IMPORT_OK")
        return 0
    except Exception:
        print("IMPORT_FAILED")
        traceback.print_exc()
        return 1


if __name__ == "__main__":
    raise SystemExit(main())

Error you get (with the current master branch

PydanticSchemaGenerationError: Unable to generate ... for <class 'bytearray'>

[cubic-dev-ai]

No issues found across 33 files

[wing328]

thanks for the fix

let's give it a try