openapi-generators / openapi-generators/openapi-python-client

`oneOf` inside `allOf` is ignored during code generation

未关闭
#1,328 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Python
星标
2k
派生
293
平均合并
34 分钟
30 天内合并 PR
1

描述

Describe the bug

When using allOf with a nested oneOf, the code generator only processes the first schema in the allOf list and ignores the oneOf portion. Fields defined in the oneOf schemas are not included as typed attributes in the generated class, but instead end up in additional_properties as untyped data.

OpenAPI Spec File

Click to expand full OpenAPI spec
openapi: 3.0.3
info:
  title: AllOf + OneOf Test
  version: 1.0.0
paths:
  /animals/{animal_id}:
    get:
      operationId: get_animal
      parameters:
        - name: animal_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Animal'

components:
  schemas:
    Animal:
      type: object
      required:
        - id
        - attributes
      properties:
        id:
          type: string
        attributes:
          allOf:
            - $ref: '#/components/schemas/CommonAttributes'
            - oneOf:
                - $ref: '#/components/schemas/DogAttributes'
                - $ref: '#/components/schemas/CatAttributes'

    CommonAttributes:
      type: object
      properties:
        name:
          type: string
          description: Animal's name
        age:
          type: integer
          description: Animal's age in years

    DogAttributes:
      type: object
      properties:
        breed:
          type: string
          description: Dog breed
        is_good_boy:
          type: boolean
          description: Is this a good boy?

    CatAttributes:
      type: object
      properties:
        color:
          type: string
          description: Cat fur color
        lives_remaining:
          type: integer
          description: Number of lives remaining (out of 9)

Key part of the spec (the problematic schema):

attributes:
  allOf:
    - $ref: '#/components/schemas/CommonAttributes'  # name, age
    - oneOf:
        - $ref: '#/components/schemas/DogAttributes'   # breed, is_good_boy
        - $ref: '#/components/schemas/CatAttributes'   # color, lives_remaining

Generated Code

The generated AnimalAttributes class only includes fields from CommonAttributes:

@_attrs_define
class AnimalAttributes:
    """
    Attributes:
        name (Union[Unset, str]): Animal's name
        age (Union[Unset, int]): Animal's age in years
    """

    name: Union[Unset, str] = UNSET
    age: Union[Unset, int] = UNSET
    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
Click to expand full generated file
from typing import Any, TypeVar, Union

from attrs import define as _attrs_define
from attrs import field as _attrs_field

from ..types import UNSET, Unset

T = TypeVar("T", bound="AnimalAttributes")


@_attrs_define
class AnimalAttributes:
    """
    Attributes:
        name (Union[Unset, str]): Animal's name
        age (Union[Unset, int]): Animal's age in years
    """

    name: Union[Unset, str] = UNSET
    age: Union[Unset, int] = UNSET
    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)

    def to_dict(self) -> dict[str, Any]:
        name = self.name

        age = self.age

        field_dict: dict[str, Any] = {}
        field_dict.update(self.additional_properties)
        field_dict.update({})
        if name is not UNSET:
            field_dict["name"] = name
        if age is not UNSET:
            field_dict["age"] = age

        return field_dict

    @classmethod
    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
        d = src_dict.copy()
        name = d.pop("name", UNSET)

        age = d.pop("age", UNSET)

        animal_attributes = cls(
            name=name,
            age=age,
        )

        animal_attributes.additional_properties = d
        return animal_attributes

    @property
    def additional_keys(self) -> list[str]:
        return list(self.additional_properties.keys())

    def __getitem__(self, key: str) -> Any:
        return self.additional_properties[key]

    def __setitem__(self, key: str, value: Any) -> None:
        self.additional_properties[key] = value

    def __delitem__(self, key: str) -> None:
        del self.additional_properties[key]

    def __contains__(self, key: str) -> bool:
        return key in self.additional_properties

Fields from DogAttributes and CatAttributes are not present as typed attributes. When parsing JSON responses containing these fields (e.g., breed, is_good_boy), they end up in additional_properties as untyped data.

Expected Behavior

Since oneOf means "exactly one of", the generator should create separate classes for each variant and use a Union type:

@_attrs_define
class AnimalAttributesWithDog:
    """CommonAttributes + DogAttributes"""
    name: Union[Unset, str] = UNSET
    age: Union[Unset, int] = UNSET
    breed: Union[Unset, str] = UNSET
    is_good_boy: Union[Unset, bool] = UNSET

@_attrs_define
class AnimalAttributesWithCat:
    """CommonAttributes + CatAttributes"""
    name: Union[Unset, str] = UNSET
    age: Union[Unset, int] = UNSET
    color: Union[Unset, str] = UNSET
    lives_remaining: Union[Unset, int] = UNSET

# The actual type used in Animal
AnimalAttributes = Union[AnimalAttributesWithDog, AnimalAttributesWithCat]

Desktop (please complete the following information):

  • OS: Linux (Ubuntu 22.04)
  • Python Version: 3.13.5
  • openapi-python-client version: 0.25.3

Additional context

Current workaround requires accessing fields via additional_properties, which loses type safety:

animal.additional_properties.get('breed')  # type is Any, not str

Note that DogAttributes and CatAttributes are generated as separate model files, but they are not merged into the AnimalAttributes class as expected from the allOf + oneOf combination.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

使用提供的 OpenAPI 规范重现该问题,并检查生成器对嵌套 allOf 和 oneOf 模式的处理;报告中未指定源文件或测试。完成的标准是,生成的 AnimalAttributes 表示保留公共字段,并以带类型的属性公开每个 oneOf 变体,而不是将它们放入 additional_properties。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
devtools
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。