Skip to content

fix: issue DeprecationWarnings for deprecated properties properly #838

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 4 commits into from
Jul 3, 2025
Merged

fix: issue DeprecationWarnings for deprecated properties properly #838

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f365313
fix: Move class attribute warnings from constructor to setter
KAWAHARA-souta Jun 27, 2025
e60c631
Update cyclonedx/model/bom.py
jkowalleck Jul 3, 2025
e2f9465
Update cyclonedx/model/component.py
jkowalleck Jul 3, 2025
5dee8fe
tidy
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: 5 additions & 6 deletions cyclonedx/model/bom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,7 @@ def __init__(
self.properties = properties or []
self.manufacturer = manufacturer
self.lifecycles = lifecycles or []

self.manufacture = manufacture
if manufacture:
warn(
'`bom.metadata.manufacture` is deprecated from CycloneDX v1.6 onwards. '
'Please use `bom.metadata.component.manufacturer` instead.',
DeprecationWarning)

@property
@serializable.type_mapping(serializable.helpers.XsdDateTime)
Expand Down Expand Up @@ -214,6 +208,11 @@ def manufacture(self, manufacture: Optional[OrganizationalEntity]) -> None:
@todo Based on https://github.com/CycloneDX/specification/issues/346,
we should set this data on `.component.manufacturer`.
"""
if manufacture:
warn(
'`bom.metadata.manufacture` is deprecated from CycloneDX v1.6 onwards. '
'Please use `bom.metadata.component.manufacturer` instead.',
DeprecationWarning)
self._manufacture = manufacture

@property
Expand Down
12 changes: 6 additions & 6 deletions cyclonedx/model/component.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1035,12 +1035,6 @@ def __init__(
self.crypto_properties = crypto_properties
self.tags = tags or []

if modified:
warn('`.component.modified` is deprecated from CycloneDX v1.3 onwards. '
'Please use `@.pedigree` instead.', DeprecationWarning)
if author:
warn('`.component.author` is deprecated from CycloneDX v1.6 onwards. '
'Please use `@.authors` or `@.manufacturer` instead.', DeprecationWarning)

@property
@serializable.type_mapping(_ComponentTypeSerializationHelper)
Expand Down Expand Up @@ -1175,6 +1169,9 @@ def author(self) -> Optional[str]:

@author.setter
def author(self, author: Optional[str]) -> None:
if author:
warn('`.component.author` is deprecated from CycloneDX v1.6 onwards. '
'Please use `@.authors` or `@.manufacturer` instead.', DeprecationWarning)
self._author = author

@property
Expand Down Expand Up @@ -1450,6 +1447,9 @@ def modified(self) -> bool:

@modified.setter
def modified(self, modified: bool) -> None:
if modified:
warn('`.component.modified` is deprecated from CycloneDX v1.3 onwards. '
'Please use `@.pedigree` instead.', DeprecationWarning)
self._modified = modified

@property
Expand Down