Skip to content

Commit b50a28a

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

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

cyclonedx/model/tool.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@
2626
from py_serializable.helpers import BaseHelper
2727
from sortedcontainers import SortedSet
2828

29+
try:
30+
from warnings import deprecated
31+
except ImportError:
32+
from typing_extensions import deprecated
33+
2934
from .._internal.compare import ComparableTuple as _ComparableTuple
3035
from ..schema import SchemaVersion
3136
from ..schema.schema import SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6
@@ -37,6 +42,12 @@
3742
from py_serializable import ObjectMetadataLibrary, ViewType
3843

3944

45+
@deprecated(
46+
'`Tool` is deprecated from CycloneDX v1.5 onwards. '
47+
'This class provides a compatibility layer for backward compatibility '
48+
'Use `Component` or `Service` instead, and store data under '
49+
'`tools.components` or `tools.services`.'
50+
)
4051
@serializable.serializable_class
4152
class Tool:
4253
"""

0 commit comments

Comments
 (0)