Skip to content

feat: decorate deprecated symbols #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 3, 2025
Merged

feat: decorate deprecated symbols #839

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f438877
fix: Annotate deprecated classes using `@deprecated`
KAWAHARA-souta Jun 30, 2025
b50a28a
fix: Annotate Tool class using `@deprecated`
KAWAHARA-souta Jun 26, 2025
223ebf7
fix: Add warnings for deprecated usage of dataClassification in old l…
KAWAHARA-souta Jun 26, 2025
39de6d1
revert warning on `models.service.Service.data`
jkowalleck Jul 3, 2025
8bee579
revert changes on model.tool
jkowalleck Jul 3, 2025
f0e21fc
adjust imports
jkowalleck Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions cyclonedx/model/tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@
from py_serializable.helpers import BaseHelper
from sortedcontainers import SortedSet

try:
from warnings import deprecated
except ImportError:
from typing_extensions import deprecated

from .._internal.compare import ComparableTuple as _ComparableTuple
from ..schema import SchemaVersion
from ..schema.schema import SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6
Expand All @@ -37,6 +42,12 @@
from py_serializable import ObjectMetadataLibrary, ViewType


@deprecated(
Copy link
Member

@jkowalleck jkowalleck Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reverted, as the added statement is not true. the data model itself was never deprecated. it is just the usage in another model, that is deprecated in certain versions of CycloneDX.

'`Tool` is deprecated from CycloneDX v1.5 onwards. '
'This class provides a compatibility layer for backward compatibility '
'Use `Component` or `Service` instead, and store data under '
'`tools.components` or `tools.services`.'
)
@serializable.serializable_class
class Tool:
"""
Expand Down
7 changes: 7 additions & 0 deletions cyclonedx/serialization/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,17 @@
from packageurl import PackageURL
from py_serializable.helpers import BaseHelper

try:
from warnings import deprecated
except ImportError:
from typing_extensions import deprecated

from ..exception.serialization import CycloneDxDeserializationException, SerializationOfUnexpectedValueException
from ..model.bom_ref import BomRef
from ..model.license import _LicenseRepositorySerializationHelper


@deprecated('Use :class:`BomRef` instead.')
class BomRefHelper(BaseHelper):
"""**DEPRECATED** in favour of :class:`BomRef`.

Expand Down Expand Up @@ -88,6 +94,7 @@ def deserialize(cls, o: Any) -> UUID:
) from err


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

Expand Down