Skip to content

Commit f438877

Browse files
fix: Annotate deprecated classes using @deprecated
Signed-off-by: Souta Kawahara <[email protected]>
1 parent 0bdc6d6 commit f438877

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

cyclonedx/serialization/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,17 @@
2727
from packageurl import PackageURL
2828
from py_serializable.helpers import BaseHelper
2929

30+
try:
31+
from warnings import deprecated
32+
except ImportError:
33+
from typing_extensions import deprecated
34+
3035
from ..exception.serialization import CycloneDxDeserializationException, SerializationOfUnexpectedValueException
3136
from ..model.bom_ref import BomRef
3237
from ..model.license import _LicenseRepositorySerializationHelper
3338

3439

40+
@deprecated('Use :class:`BomRef` instead.')
3541
class BomRefHelper(BaseHelper):
3642
"""**DEPRECATED** in favour of :class:`BomRef`.
3743
@@ -88,6 +94,7 @@ def deserialize(cls, o: Any) -> UUID:
8894
) from err
8995

9096

97+
@deprecated('No public API planned for replacing this,')
9198
class LicenseRepositoryHelper(_LicenseRepositorySerializationHelper):
9299
"""**DEPRECATED**
93100

0 commit comments

Comments
 (0)