CycloneDX / CycloneDX/cyclonedx-python-lib

feat: improve deprecation warnings - PEP-387

Ouverte
#760 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Python
Étoiles
116
Forks
67
Merge moyen
8 j 2 h
PR mergées (30 j)
2

Description

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

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.