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

chore!: Automate data model generation from upcoming CycloneDX 2.0 modularized specification

Đang mở
  • Có gì không ổn?
#955 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
build-system, tooling

Hướng nghiên cứu

Bắt đầu với schema CycloneDX 2.0 trong schema/2.0/model và xem xét các công cụ sinh mã được nêu tên cùng phần công việc proof-of-concept. Xác định cách tiền xử lý, sinh mã, hậu xử lý và đầu ra đã commit phù hợp với quy trình build hoặc release của dự án. Done bao gồm các model xác định, tài liệu và ví dụ được cập nhật, các bài kiểm thử schema và enum, cùng hướng dẫn chuyển tiếp hoặc các hạn chế khi di chuyển được ghi lại.

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

Mô tả

breaking change chore enhancement schema 2.0
Description

Currently, the data models in this library are largely written and maintained manually. While this approach has worked so far, it is time-consuming and requires significant effort for both implementation and review. This effort could be better invested in feature development and bug fixing. (Also the issue is that the models code also implement the business logic, like property constraints, etc.)

With the upcoming CycloneDX 2.0 specification, a modularized and machine-readable format will be introduced. This presents an opportunity to rethink how data models are created and maintained in this project.

Reference (work in progress):

Problem
  • Data models are mostly handwritten and mix in the business logic
  • High maintenance overhead
  • Repetitive work for contributors
  • Slows down development velocity due to review effort
Proposal

Leverage the machine-readable specification planned for CycloneDX 2.0 to introduce static code generation for data models (not business logic).

This would involve:

  • Parsing the official CycloneDX specification (once available in machine-readable form)
  • Generating Python data models automatically
  • Integrating generation into the build or release process
  • Minimizing manual intervention for future spec updates

There have already been proof-of-concept implementations demonstrating that automated generation of data models from the specification is feasible. These approaches should be revisited, consolidated, and applied as part of this effort.

Pipeline:

flowchart TB
    A["Input: CycloneDX JSON Schema files"]
    B["Preprocessing (if needed)"]
    C["Code Generation"]
    D["Post-processing: formatting, code style, adjustments"]

    subgraph E["Result: Generated Python code"]
        direction LR
        E1["Data Models"]
        E2["Factories"]
        E3["Serialization-specific Normalizers"]
    end

    A --> B --> C --> D --> E

Philosophy: decouple logic fro mdata

  • Models are pure dumb typed data classes.
  • Factories implement business logic for instancing data classes with the propeties' constrinats defined in the schema
  • normalizers turn data classes into objects that can be handed over to serializers
  • serializers take prepared objects and render XML/JSON/PB

possible file layput in the distributable:

Core
  V1
  v2
    Models
      Cyclonedx
      Modules
        Common
   Normalizers
   Serializes
Possible Tools / Libraries

The following tools could be evaluated as part of this effort:

Community Input

Community discussions have already suggested evaluating tools such as:

and

These should be considered as primary candidates during evaluation.

see discussions:

Expected Benefits
  • Significant reduction in maintenance effort
  • Improved consistency across models
  • Faster adoption of new specification versions
  • More time available for feature development and bug fixing
Considerations / Open Questions
  • What format will the machine-readable spec be published in (e.g., JSON Schema, OpenAPI, etc.)?
    • JSON Schema it is
  • Should generated code be committed or generated at build time?
    • decision: generated before build time, and commited to the repo
  • How to handle custom logic or extensions on top of generated models?
  • Backward compatibility with CycloneDX 1.x
    • easy path: breaking change in the library, and only support 2.0 from then on
Additional Context

This proposal aligns with the direction of CycloneDX 2.0, which aims to make the specification more modular and tooling-friendly. Taking advantage of this early could significantly improve long-term maintainability of this library.

Note: This issue is intended as a meta-ticket to collect related sub-tasks and track overall implementation efforts.

Checklist

  • have the models created in a deterministic way from schema
  • generate the docs
  • have examples updated
  • have tests
    • test with all schema test cases
    • tests all enum completeness
  • write a transition guide in the docs
    • section "Upgrading to vXXX"
    • we might not be able to provide a proper guide at all, since basically everything is rewrite.
    • we might point to the github discussions - section FAQ - to pride at least some help
Ngôn ngữ chính
Python
Star
117
Fork
67
Merge trung bình
21 giờ 9 phút
Pull request đã merge (30 ngày)
3

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

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 CycloneDX/cyclonedx-python-lib

Tất cả issue của CycloneDX/cyclonedx-python-lib

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.