feat: prepare "contrib" area

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

Author: jkowalleck

cyclonedx/model/__init__.py

@@ -31,13 +31,12 @@
 from typing import Any, Optional, Union
 from urllib.parse import quote as url_quote
 from uuid import UUID
-from warnings import warn
+from warnings import warn, deprecated
 from xml.etree.ElementTree import Element as XmlElement  # nosec B405
 
 import py_serializable as serializable
 from sortedcontainers import SortedSet
 
-from contrib.hash.factories import HashTypeFactory
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from ..exception.model import InvalidLocaleTypeException, InvalidUriException
 from ..exception.serialization import CycloneDxDeserializationException, SerializationOfUnexpectedValueException
@@ -377,6 +376,7 @@ class HashType:
     """
 
     @staticmethod
+    @deprecated('Deprecated - use cyclonedx.contrib.hash.factories.HashTypeFactory.from_hashlib_alg instead')
     def from_hashlib_alg(hashlib_alg: str, content: str) -> 'HashType':
         """Deprecated — Alias of :func:`cyclonedx.contrib.hash.factories.HashTypeFactory.from_hashlib_alge`.
 
@@ -385,9 +385,12 @@ def from_hashlib_alg(hashlib_alg: str, content: str) -> 'HashType':
         .. deprecated:: next
             Use ``cyclonedx.contrib.hash.factories.HashTypeFactory.from_hashlib_alg()`` instead.
         """
+        from ..contrib.hash.factories import HashTypeFactory
+
         return HashTypeFactory().from_hashlib_alg(hashlib_alg, content)
 
     @staticmethod
+    @deprecated('Deprecated - use cyclonedx.contrib.hash.factories.HashTypeFactory.from_composite_str instead')
     def from_composite_str(composite_hash: str) -> 'HashType':
         """Deprecated — Alias of :func:`cyclonedx.contrib.hash.factories.HashTypeFactory.from_composite_str`.
 
@@ -397,6 +400,8 @@ def from_composite_str(composite_hash: str) -> 'HashType':
         .. deprecated:: next
             Use ``cyclonedx.contrib.hash.factories.HashTypeFactory.from_composite_str()`` instead.
         """
+        from ..contrib.hash.factories import HashTypeFactory
+
         return HashTypeFactory().from_composite_str(composite_hash)
 
     def __init__(

cyclonedx/model/component.py

@@ -27,7 +27,6 @@
 from sortedcontainers import SortedSet
 from typing_extensions import deprecated
 
-from contrib.component.builders import ComponentBuilder
 from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
 from .._internal.compare import ComparablePackageURL as _ComparablePackageURL, ComparableTuple as _ComparableTuple
 from ..exception.model import InvalidOmniBorIdException, InvalidSwhidException
@@ -963,6 +962,8 @@ def for_file(absolute_file_path: str, path_for_bom: Optional[str]) -> 'Component
         .. deprecated:: next
             Use ``cyclonedx.contrib.component.builders.ComponentBuilder.make_for_file()`` instead.
         """
+        from ..contrib.component.builders import ComponentBuilder
+
         component = ComponentBuilder().make_for_file(absolute_file_path, name=path_for_bom)
         sha1_hash = next(h.content for h in component.hashes if h.alg is HashAlgorithm.SHA_1)
         component.version=f'0.0.0-{sha1_hash[0:12]}'

tests/test_component.py

@@ -21,7 +21,7 @@
 # See https://github.com/package-url/packageurl-python/issues/65
 from packageurl import PackageURL
 
-from cyclonedx._internal.hash import file_sha1sum as _file_sha1sum
+from cyclonedx.contrib.component.builders import ComponentBuilder
 from cyclonedx.model.component import Component
 from tests import OWN_DATA_DIRECTORY
 from tests._data.models import get_component_setuptools_simple
@@ -65,7 +65,7 @@ def test_purl_incorrect_name(self) -> None:
     def test_from_xml_file_with_path_for_bom(self) -> None:
         test_file = join(OWN_DATA_DIRECTORY, 'xml', '1.4', 'bom_setuptools.xml')
         c = Component.for_file(absolute_file_path=test_file, path_for_bom='fixtures/bom_setuptools.xml')
-        sha1_hash: str = _file_sha1sum(filename=test_file)
+        sha1_hash: str = ComponentBuilder._file_sha1sum(filename=test_file)
         expected_version = f'0.0.0-{sha1_hash[0:12]}'
         self.assertEqual(c.name, 'fixtures/bom_setuptools.xml')
         self.assertEqual(c.version, expected_version)