better naming

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

Author: jkowalleck

cyclonedx/model/bom.py

@@ -30,7 +30,7 @@
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from .._internal.time import get_now_utc as _get_now_utc
 from ..exception.model import LicenseExpressionAlongWithOthersException, UnknownComponentDependencyException
-from ..schema.deprecation import DeprecationWarning1Dot6
+from ..schema.deprecation import SchemaDeprecationWarning1Dot6
 from ..schema.schema import (
     SchemaVersion1Dot0,
     SchemaVersion1Dot1,
@@ -292,7 +292,7 @@ def manufacture(self, manufacture: Optional[OrganizationalEntity]) -> None:
               we should set this data on `.component.manufacturer`.
         """
         if manufacture is not None:
-            DeprecationWarning1Dot6._warn('bom.metadata.manufacture', 'bom.metadata.component.manufacturer')
+            SchemaDeprecationWarning1Dot6._warn('bom.metadata.manufacture', 'bom.metadata.component.manufacturer')
         self._manufacture = manufacture
 
     @property

cyclonedx/model/component.py

@@ -40,7 +40,10 @@
     SerializationOfUnexpectedValueException,
     SerializationOfUnsupportedComponentTypeException,
 )
-from ..schema.deprecation import DeprecationWarning1Dot3, DeprecationWarning1Dot6
+from ..schema.deprecation import (
+    SchemaDeprecationWarning1Dot3,
+    SchemaDeprecationWarning1Dot6,
+)
 from ..schema.schema import (
     SchemaVersion1Dot0,
     SchemaVersion1Dot1,
@@ -1186,7 +1189,7 @@ def author(self) -> Optional[str]:
     @author.setter
     def author(self, author: Optional[str]) -> None:
         if author is not None:
-            DeprecationWarning1Dot6._warn('@.author', '@.authors` or `@.manufacturer')
+            SchemaDeprecationWarning1Dot6._warn('@.author', '@.authors` or `@.manufacturer')
         self._author = author
 
     @property
@@ -1467,7 +1470,7 @@ def modified(self) -> bool:
     @modified.setter
     def modified(self, modified: bool) -> None:
         if modified:
-            DeprecationWarning1Dot3._warn('@.modified', '@.pedigree')
+            SchemaDeprecationWarning1Dot3._warn('@.modified', '@.pedigree')
         self._modified = modified
 
     @property

cyclonedx/model/tool.py

@@ -27,7 +27,7 @@
 
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from ..schema import SchemaVersion
-from ..schema.deprecation import DeprecationWarning1Dot5
+from ..schema.deprecation import SchemaDeprecationWarning1Dot5
 from ..schema.schema import SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6, SchemaVersion1Dot7
 from . import ExternalReference, HashType, _HashTypeRepositorySerializationHelper
 from .component import Component
@@ -240,7 +240,7 @@ def tools(self) -> 'SortedSet[Tool]':
     @tools.setter
     def tools(self, tools: Iterable[Tool]) -> None:
         if tools:
-            DeprecationWarning1Dot5._warn('@.tools', '@.components` and `@.services')
+            SchemaDeprecationWarning1Dot5._warn('@.tools', '@.components` and `@.services')
         self._tools = SortedSet(tools)
 
     def __len__(self) -> int:

cyclonedx/schema/deprecation.py

@@ -23,17 +23,17 @@
 
 __all__ = [
     'SchemaDeprecationWarning',
-    'DeprecationWarning1Dot1',
-    'DeprecationWarning1Dot2',
-    'DeprecationWarning1Dot3',
-    'DeprecationWarning1Dot4',
-    'DeprecationWarning1Dot5',
-    'DeprecationWarning1Dot6',
-    'DeprecationWarning1Dot7',
+    'SchemaDeprecationWarning1Dot1',
+    'SchemaDeprecationWarning1Dot2',
+    'SchemaDeprecationWarning1Dot3',
+    'SchemaDeprecationWarning1Dot4',
+    'SchemaDeprecationWarning1Dot5',
+    'SchemaDeprecationWarning1Dot6',
+    'SchemaDeprecationWarning1Dot7',
 ]
 
 
-class SchemaDeprecationWarning(DeprecationWarning, ABC):
+class BaseSchemaDeprecationWarning(DeprecationWarning, ABC):
     """Base class for warnings about deprecated schema features."""
 
     SCHEMA_VERSION: ClassVar[SchemaVersion]
@@ -47,36 +47,36 @@ def _warn(cls, deprecated: str, instead: Optional[str] = None, *, stacklevel: in
         warn(msg, category=cls, stacklevel=stacklevel + 1)
 
 
-class DeprecationWarning1Dot7(SchemaDeprecationWarning):
+class SchemaDeprecationWarning1Dot7(BaseSchemaDeprecationWarning):
     """Class for warnings about deprecated schema features in CycloneDX 1.7"""
     SCHEMA_VERSION: ClassVar[Literal[SchemaVersion.V1_7]] = SchemaVersion.V1_7
 
 
-class DeprecationWarning1Dot6(SchemaDeprecationWarning):
+class SchemaDeprecationWarning1Dot6(BaseSchemaDeprecationWarning):
     """Class for warnings about deprecated schema features in CycloneDX 1.6"""
     SCHEMA_VERSION: ClassVar[Literal[SchemaVersion.V1_6]] = SchemaVersion.V1_6
 
 
-class DeprecationWarning1Dot5(SchemaDeprecationWarning):
+class SchemaDeprecationWarning1Dot5(BaseSchemaDeprecationWarning):
     """Class for warnings about deprecated schema features in CycloneDX 1.5"""
     SCHEMA_VERSION: ClassVar[Literal[SchemaVersion.V1_5]] = SchemaVersion.V1_5
 
 
-class DeprecationWarning1Dot4(SchemaDeprecationWarning):
+class SchemaDeprecationWarning1Dot4(BaseSchemaDeprecationWarning):
     """Class for warnings about deprecated schema features in CycloneDX 1.4"""
     SCHEMA_VERSION: ClassVar[Literal[SchemaVersion.V1_4]] = SchemaVersion.V1_4
 
 
-class DeprecationWarning1Dot3(SchemaDeprecationWarning):
+class SchemaDeprecationWarning1Dot3(BaseSchemaDeprecationWarning):
     """Class for warnings about deprecated schema features in CycloneDX 1.3"""
     SCHEMA_VERSION: ClassVar[Literal[SchemaVersion.V1_3]] = SchemaVersion.V1_3
 
 
-class DeprecationWarning1Dot2(SchemaDeprecationWarning):
+class SchemaDeprecationWarning1Dot2(BaseSchemaDeprecationWarning):
     """Class for warnings about deprecated schema features in CycloneDX 1.2"""
     SCHEMA_VERSION: ClassVar[Literal[SchemaVersion.V1_2]] = SchemaVersion.V1_2
 
 
-class DeprecationWarning1Dot1(SchemaDeprecationWarning):
+class SchemaDeprecationWarning1Dot1(BaseSchemaDeprecationWarning):
     """Class for warnings about deprecated schema features in CycloneDX 1.1"""
     SCHEMA_VERSION: ClassVar[Literal[SchemaVersion.V1_1]] = SchemaVersion.V1_1

examples/complex_deserialize.py

@@ -25,7 +25,7 @@
 from cyclonedx.exception import MissingOptionalDependencyException
 from cyclonedx.model.bom import Bom
 from cyclonedx.schema import OutputFormat, SchemaVersion
-from cyclonedx.schema.deprecation import SchemaDeprecationWarning
+from cyclonedx.schema.deprecation import BaseSchemaDeprecationWarning
 from cyclonedx.validation import make_schemabased_validator
 from cyclonedx.validation.json import JsonStrictValidator
 
@@ -157,7 +157,7 @@
 except MissingOptionalDependencyException as error:
     print('JSON-validation was skipped due to', error)
 with warnings.catch_warnings():
-    warnings.filterwarnings('ignore', category=SchemaDeprecationWarning)
+    warnings.filterwarnings('ignore', category=BaseSchemaDeprecationWarning)
     bom_from_json = Bom.from_json(  # type: ignore[attr-defined]
         json_loads(json_data))
 print('bom_from_json', repr(bom_from_json))
@@ -260,7 +260,7 @@
 except MissingOptionalDependencyException as error:
     print('XML-validation was skipped due to', error)
 with warnings.catch_warnings():
-    warnings.filterwarnings('ignore', category=SchemaDeprecationWarning)
+    warnings.filterwarnings('ignore', category=BaseSchemaDeprecationWarning)
     bom_from_xml = Bom.from_xml(  # type: ignore[attr-defined]
         SafeElementTree.fromstring(xml_data))
 print('bom_from_xml', repr(bom_from_xml))