helpers and pythonic

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

cyclonedx/model/bom.py

@@ -292,10 +292,7 @@ def manufacture(self, manufacture: Optional[OrganizationalEntity]) -> None:
               we should set this data on `.component.manufacturer`.
         """
         if manufacture is not None:
-            warn(
-                '`bom.metadata.manufacture` is deprecated from CycloneDX v1.6 onwards. '
-                'Please use `bom.metadata.component.manufacturer` instead.',
-                DeprecationWarning1Dot6)
+            warn(*DeprecationWarning1Dot6._prepw('bom.metadata.manufacture', 'bom.metadata.component.manufacturer'))
         self._manufacture = manufacture
 
     @property

cyclonedx/model/component.py

@@ -1186,8 +1186,7 @@ def author(self) -> Optional[str]:
     @author.setter
     def author(self, author: Optional[str]) -> None:
         if author is not None:
-            warn('`@.author` is deprecated from CycloneDX v1.6 onwards. '
-                 'Please use `@.authors` or `@.manufacturer` instead.', DeprecationWarning1Dot6)
+            warn(*DeprecationWarning1Dot6._prepw('@.author', '@.authors` or `@.manufacturer'))
         self._author = author
 
     @property
@@ -1468,8 +1467,7 @@ def modified(self) -> bool:
     @modified.setter
     def modified(self, modified: bool) -> None:
         if modified:
-            warn('`@.modified` is deprecated from CycloneDX v1.3 onwards. '
-                 'Please use `@.pedigree` instead.', DeprecationWarning1Dot3)
+            warn(*DeprecationWarning1Dot3._prepw('@.modified', '@.pedigree'))
         self._modified = modified
 
     @property

cyclonedx/model/tool.py

@@ -241,9 +241,7 @@ def tools(self) -> 'SortedSet[Tool]':
     @tools.setter
     def tools(self, tools: Iterable[Tool]) -> None:
         if tools:
-            warn('`@.tools` is deprecated from CycloneDX v1.5 onwards. '
-                 'Please use `@.components` and `@.services` instead.',
-                 DeprecationWarning1Dot5)
+            warn(*DeprecationWarning1Dot5._prepw('@.tools', '@.components` and `@.services'))
         self._tools = SortedSet(tools)
 
     def __len__(self) -> int:

cyclonedx/schema/deprecation.py

@@ -15,59 +15,65 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) OWASP Foundation. All Rights Reserved.
 
-from abc import ABC, abstractmethod
-from typing import Literal
+from abc import ABC
+from typing import ClassVar, Optional
 
 from . import SchemaVersion
 
+__all__ = [
+    'SchemaDeprecationWarning',
+    'DeprecationWarning1Dot1',
+    'DeprecationWarning1Dot2',
+    'DeprecationWarning1Dot3',
+    'DeprecationWarning1Dot4',
+    'DeprecationWarning1Dot5',
+    'DeprecationWarning1Dot6',
+    'DeprecationWarning1Dot7',
+]
+
 
 class SchemaDeprecationWarning(DeprecationWarning, ABC):
-    @property
-    @abstractmethod
-    def schema_version_enum(self) -> SchemaVersion:
-        ...  # pragma: no cover
+    SCHEMA_VERSION: ClassVar[SchemaVersion]
+
+    @classmethod
+    def _prepw(cls, deprecated: str, instead: Optional[str] = None) -> tuple[str, type[SchemaDeprecationWarning]]:
+        """Prepare the warning message and category for schema deprecations.
+
+        Internal API. Not part of the public interface.
+
+        Intended to be used as:
 
-    def get_schema_version(self) -> str:
-        return self.schema_version_enum.to_version()
+            warnings.warn(*SchemaDeprecationWarning._prepw("foo", "bar"))
+        """
+        w = f'`{deprecated}` is deprecated from CycloneDX v{cls.SCHEMA_VERSION.to_version()} onwards.'
+        if instead is not None:
+            w += f' Please use `{instead}` instead.'
+        return w, cls
 
 
 class DeprecationWarning1Dot7(SchemaDeprecationWarning):
-    @property
-    def schema_version_enum(self) -> Literal[SchemaVersion.V1_7]:
-        return SchemaVersion.V1_7
+    SCHEMA_VERSION = SchemaVersion.V1_7
 
 
 class DeprecationWarning1Dot6(SchemaDeprecationWarning):
-    @property
-    def schema_version_enum(self) -> Literal[SchemaVersion.V1_6]:
-        return SchemaVersion.V1_6
+    SCHEMA_VERSION = SchemaVersion.V1_6
 
 
 class DeprecationWarning1Dot5(SchemaDeprecationWarning):
-    @property
-    def schema_version_enum(self) -> Literal[SchemaVersion.V1_5]:
-        return SchemaVersion.V1_5
+    SCHEMA_VERSION = SchemaVersion.V1_5
 
 
 class DeprecationWarning1Dot4(SchemaDeprecationWarning):
-    @property
-    def schema_version_enum(self) -> Literal[SchemaVersion.V1_4]:
-        return SchemaVersion.V1_4
+    SCHEMA_VERSION = SchemaVersion.V1_4
 
 
 class DeprecationWarning1Dot3(SchemaDeprecationWarning):
-    @property
-    def schema_version_enum(self) -> Literal[SchemaVersion.V1_3]:
-        return SchemaVersion.V1_3
+    SCHEMA_VERSION = SchemaVersion.V1_3
 
 
 class DeprecationWarning1Dot2(SchemaDeprecationWarning):
-    @property
-    def schema_version_enum(self) -> Literal[SchemaVersion.V1_2]:
-        return SchemaVersion.V1_2
+    _schema_version_enum = SchemaVersion.V1_2
 
 
 class DeprecationWarning1Dot1(SchemaDeprecationWarning):
-    @property
-    def schema_version_enum(self) -> Literal[SchemaVersion.V1_1]:
-        return SchemaVersion.V1_1
+    _schema_version_enum = SchemaVersion.V1_1