OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Python-Fastapi] Incorrect encoding of regex lookahead (?=...) in generated code

Open
#19,841 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

When using a regular expression with a lookahead (?=...) in an OpenAPI specification, the generated code returns an incorrect encoding of the lookahead, where ?= becomes ?=.

openapi-generator version

v7.9.0

OpenAPI declaration file content or url

Here is an example of the OpenAPI declaration file content:

https://gist.github.com/reyescabello/6cd965708fd0b03e8eadb9f3c0c0a899

Generation Details

Generated with jar:

java -jar openapi-generator-cli.jar generate -i openapi.yml -g python-fastapi -o openapi_server

Steps to reproduce

When generating the specified content in the OpenAPI file, the endpoint that includes the pattern looks like this:

async def find_product_by_code(
    code: str = Path(
    description="Product code to search", 
    regex=r"/^(?=.*[A-Z])(?=.*\d)[A-Z\d]{8,12}$/"),
) -> Product:
    """The user must have any permission in the application."""
    return await BaseProductApi.subclasses[0]().find_product_by_code(code)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the OpenAPI declaration linked in the issue and reproduce generation using the shown openapi-generator CLI command with the python-fastapi generator. Compare the generated endpoint's regex in the output with the source pattern; done means the lookahead remains encoded as (?=...) rather than ?=.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, openapi, python
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.