CycloneDX / CycloneDX/cyclonedx-python-lib

feat: improve deprecation warnings - PEP-387

Abierto
#760 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Python
Estrellas
116
Forks
67
Merge medio
8 d 2 h
PR fusionados (30 d)
2

Descripción

see also: https://peps.python.org/pep-0387/

goal: improve backwards compatibility, while improving Developer experience.

## solution

- [x] move deprecated property warnings to setters
- via #838
- [x] annotate deprecated symbols
- via #839
- [ ] use `DeprecationWarning` instead of warnings. -- DEBATABLE -- see below
- requires py8.13

## important

we dont have any intention to remove deprecated properties, unless we have a backwards-compatibility layer that guarantees that all supported versions of CycloneDX spec are serializable and deserializable.

## implementation

- use for annotation of symbols: https://typing-extensions.readthedocs.io/en/latest/#typing_extensions.deprecated

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Empieza leyendo PEP-387 y la lista de comprobación de la issue; después, revisa la implementación de la advertencia de obsolescencia y las versiones de Python compatibles. La decisión pendiente es si se debe usar DeprecationWarning; para darlo por terminado, es necesario llegar a un acuerdo sobre esa elección y la compatibilidad con las versiones compatibles. La issue no especifica archivos ni pruebas.

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

Evaluación

Stack tecnológico
python
Área
developer-experience
Tipo de issue
Refactorización
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.