[python][client] Add Decimal support to mapNumberTo functionality

Merged
MA
5mo ago
+43-8

Add so that the Python generator support so that the number type can be mapped to Decimal. Note that the is strictly for the Python generator, and not for the python-pydantic-v1 generator. This is intentional since they are based upon different AbstractCodegens that do not share their logic. If it is of interest to have all Python generators share this new behavior I would suggest creating a shared type resolver so that all Python generators could get the same functionality without code duplication.

The mapNumberTo function is retained as a scoped (argument-limited) function rather than a completely open one. This since the Python validation logic required outside knowledge that is currently not injectable by the client, so having an open function might currently be counterintuitive.

Fixes: #23887

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.

cc @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @arun-nalla (2019/11)


Summary by cubic

Adds support for mapping OpenAPI number types to Decimal in the python client via mapNumberTo, enabling high‑precision values (e.g., money) while preserving validation. Fixes #23887.

  • New Features

    • mapNumberTo now accepts Decimal (supported: Union[StrictFloat, StrictInt], StrictFloat, float, Decimal) and keeps numeric constraints.
    • Generates correct imports/types (adds decimal import; fixes typing.Optional import); error message lists all supported values.
    • Docs and CLI help updated to include Decimal and fix StrictFloat (was StrictStr).
    • Tests cover all mappings via a data provider.
    • Scope: python generator only; not python-pydantic-v1.
  • Migration

    • Set mapNumberTo: "Decimal" in the generator config (Python generator only).