refactor

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

Author: jkowalleck

cyclonedx/output/json.py

@@ -41,7 +41,12 @@
     from ..model.bom import Bom
 
 
-class _BomDependencyGraphFlattener():
+class _BomDependencyGraphFlattener:
+    """
+    !!! THIS CLASS IS INTERNAL.
+    Everything might change without any notice.
+    """
+
     def __init__(self, bom: 'Bom'):
         self._bom = bom
         # do NOT use the getter - see `reset()` for reasons
@@ -54,7 +59,7 @@ def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
         self.reset()
 
     def reset(self) -> None:
-        # do NOT use the setter - this would create overhead and most importantly,
+        # Do NOT use the setter - this would create overhead and most importantly,
         # and this could cause deduplication of an existing malformed set.
         # Just access the internal field directly!
         self._bom._dependencies = self._deps

tests/test_output_json.py

@@ -116,3 +116,11 @@ def test_get_outputter_expected(self, sv: SchemaVersion) -> None:
         outputter = outputter_class(Mock(spec=Bom))
         self.assertIs(outputter.schema_version, sv)
         self.assertIs(outputter.output_format, OutputFormat.JSON)
+
+
+class TestBomDependencyGraphFlattener(TestCase):
+    def test_discriminate_and_reset_with(self) -> None:
+        ... # TODO
+
+    def test_discriminate_and_reset_manually(self) -> None:
+        ... # TODO