openapi-generators / openapi-generators/openapi-python-client
Quotes in Content-Type cause syntax errors
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 2k
- Fork
- 293
- Merge trung bình
- 34 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
Describe the bug
Running openapi-python-client generate --path api.yml on the input file below fails with:
Generating /tmp/example-client
Error(s) encountered while generating, client was not created
ruff failed
example_client/api/default/put_object.py:34:62: SyntaxError: Simple statements must be separated by newlines or semicolons
|
33 | _kwargs["json"] = _body
34 | headers["Content-Type"] = "application/ld+json; profile="https://www.w3.org/ns/activitystreams""
| ^
35 |
36 | _kwargs["headers"] = headers
|
[...]
Quotes in the Content-Type should be escaped so that the generated result is legal Python code.
OpenAPI Spec File
openapi: "3.0.0"
info:
version: 0.0.1
title: example
paths:
/object:
put:
requestBody:
content:
"application/ld+json; profile=\"https://www.w3.org/ns/activitystreams\"":
schema:
type: string
responses:
'200':
description: OK
Desktop (please complete the following information):
- OS: Debian 13
- Python Version: 3.12.11
- openapi-python-client version: 0.24.3
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Tái hiện lỗi bằng openapi-python-client generate --path api.yml sử dụng ví dụ OpenAPI trong issue, sau đó lần theo nơi giá trị Content-Type trở thành phép gán headers được tạo. Công việc được xem là hoàn tất khi các tham số Content-Type được đặt trong dấu ngoặc kép tạo ra Python hợp lệ và quá trình tạo hoàn tất mà không gặp lỗi cú pháp Ruff đã báo cáo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- tooling
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100