OpenAPITools
[BUG][Python] The schemaMappings and importMappings do not work in Python clients.
Bug Report Checklist
- [x] Have you provided a full/minimal spec to reproduce the issue?
- [x] Have you validated the input using an OpenAPI validator (example)?
- [x] Have you tested with the latest master to confirm the issue still exists?
- [x] Have you searched for related issues/PRs?
- [x] What's the actual output vs expected output?
- [ ] [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
I am generating a Python client. I want to import some classes instead of generating them. The documentation says to use importMappings or schemaMappings. They don't work.
The importMappings are ignored. I found the code that clears them:
// clear import mapping (from default generator) as python does not use it
// at the moment
importMapping.clear();
The schemaMappings can be used to map the schema to something else (e.g. external objects/models outside of the package) according to the customization page. It is unclear how to set them when generating Python clients. They do not add import statements at the top of the generated file. Instead, they camelCase the values. I have used the schemaMappings successfully when generating Java clients for my API, but for Python client codegen they don't work.
I appreciate any advice. Thanks.
openapi-generator version
7.2.0
OpenAPI declaration file content or url
openapi: 3.0.3
info:
version: 2.7.0
title: Person API
tags:
- name: Person
description: Part of the Person API.
x-tag-expanded: false
paths:
/person:
get:
tags:
- Person
summary: Get a Person
operationId: getPerson
responses:
'200':
description: A person object.
content:
application/json:
schema:
$ref: '#/components/schemas/Person'
components:
schemas:
# The Address should be imported, not generated
Address:
type: object
properties:
full_address:
type: string
Person:
type: object
properties:
id:
type: string
first_name:
type: string
last_name:
type: string
age:
type: integer
address:
$ref: '#/components/schemas/Address'
Generation Details
Steps to reproduce
Use the gradle plugin with these settings:
tasks.create("PersonGeneratorTask", GenerateTask) {
outputDir.set(outputDirectory)
inputSpec.set(filePath)
generatorName.set("python")
generateApiTests.set(false)
generateApiDocumentation.set(false)
generateModelTests.set(false)
generateModelDocumentation.set(false)
apiNameSuffix.set("Client")
packageName.set("test_clients.person")
configOptions.set([
"hideGenerationTimestamp": "true",
"generateSourceCodeOnly" : "true"
])
importMappings.set([
"Address": "from some_file import Address"
// Also tried "Address": "some_file"
])
schemaMappings.set([
"Address": "from some_file import Address"
])
}
The result is the following code:
from __future__ import annotations
import pprint
import re # noqa: F401
import json
from typing import Any, ClassVar, Dict, List, Optional
from pydantic import BaseModel, StrictInt, StrictStr
try:
from typing import Self
except ImportError:
from typing_extensions import Self
class Person(BaseModel):
"""
Person
""" # noqa: E501
id: Optional[StrictStr] = None
first_name: Optional[StrictStr] = None
last_name: Optional[StrictStr] = None
age: Optional[StrictInt] = None
address: Optional[FromSomeFileImportAddress] = None
__properties: ClassVar[List[str]] = ["id", "first_name", "last_name", "age", "address"]
Related issues/PRs
Suggest a fix
I defined custom templates for the api and the model moustache files. It works in my case but it's not ideal
+1 for this not working. The ability to substitute external models in place of generated ones is critical. Not sure why this is unsupported by this generatort.
