Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#955 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
build-system, tooling

Línea de trabajo

Comience con el esquema CycloneDX 2.0 en schema/2.0/model y revise las herramientas de generación mencionadas y el trabajo de prueba de concepto. Defina cómo encajan el preprocesamiento, la generación de código, el posprocesamiento y la salida confirmada en el proceso de build o release del proyecto. Done incluye modelos deterministas, documentación y ejemplos actualizados, pruebas del esquema y de enum, y una guía de transición o limitaciones de migración documentadas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Python
Estrellas
117
Forks
67
Merge medio
21 h 9 min
PR fusionados (30 d)
3

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de CycloneDX/cyclonedx-python-lib

Todos los issues de CycloneDX/cyclonedx-python-lib

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.