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

Changes from all 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
8 changes: 8 additions & 0 deletions cyclonedx/serialization/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,25 @@
Set of helper classes for use with ``serializable`` when conducting (de-)serialization.
"""

import sys
from typing import Any, Optional
from uuid import UUID

# See https://github.com/package-url/packageurl-python/issues/65
from packageurl import PackageURL
from py_serializable.helpers import BaseHelper

if sys.version_info > (3, 13):
from warnings import deprecated
else:
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 +95,7 @@ def deserialize(cls, o: Any) -> UUID:
) from err


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

Expand Down