Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

--use-field-description never writes GraphQL enum value descriptions

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#5,587 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
graphql, python
Lĩnh vực
api, backend

Hướng nghiên cứu

Trước tiên, hãy theo dõi cách các giá trị enum của GraphQL được chuyển đổi thành các mô hình Python khi bật --use-field-description, sau đó so sánh luồng này với cách xử lý mô tả enum trong JSON Schema. Thêm mô tả dưới dạng docstring cho các thành viên enum được tạo, theo ví dụ. Hoàn tất khi đầu vào GraphQL được hiển thị tạo ra docstring cho cả RED và BLUE.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

bug

--use-field-description writes enum value descriptions for JSON Schema but never for GraphQL.

enumdesc.graphql:

enum Color {
  "the red one"
  RED
  "the blue one"
  BLUE
}
type A { c: Color }

datamodel-codegen --input enumdesc.graphql --input-file-type graphql --use-field-description --output-model-type pydantic_v2.BaseModel

Observed:

class Color(StrEnum):
    BLUE = 'BLUE'
    RED = 'RED'

Expected: the descriptions as docstrings, as the JSON Schema equivalent ("enum": ["RED", "BLUE"], "x-enum-descriptions": ["the red one", "the blue one"]) gets:

class Color(StrEnum):
    RED = 'RED'
    """
    the red one
    """
    BLUE = 'BLUE'
    """
    the blue one
    """
Ngôn ngữ chính
Python
Star
4k
Fork
460
Merge trung bình
9 giờ 43 phút
Pull request đã merge (30 ngày)
812

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của datamodel-code-generator/datamodel-code-generator

Tất cả issue của datamodel-code-generator/datamodel-code-generator

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.