diff --git a/docs/changelog.d/+public-missing-extra-error.feature.rst b/docs/changelog.d/+public-missing-extra-error.feature.rst new file mode 100644 index 0000000..2ce5856 --- /dev/null +++ b/docs/changelog.d/+public-missing-extra-error.feature.rst @@ -0,0 +1,2 @@ +Expose ``MissingExtraError`` from ``python_sbom`` so callers can catch a missing optional dependency without importing +the private errors module. diff --git a/docs/reference/api.rst b/docs/reference/api.rst index 5514eea..3019ea0 100644 --- a/docs/reference/api.rst +++ b/docs/reference/api.rst @@ -102,3 +102,5 @@ every key. ******** .. autoexception:: python_sbom.SbomError + +.. autoexception:: python_sbom.MissingExtraError diff --git a/src/python_sbom/__init__.py b/src/python_sbom/__init__.py index a71cd89..6345a1f 100644 --- a/src/python_sbom/__init__.py +++ b/src/python_sbom/__init__.py @@ -2,7 +2,7 @@ from __future__ import annotations -from ._errors import SbomError +from ._errors import MissingExtraError, SbomError from ._model._content import BundledWheelInfo, ContentProvider, Contributions, ProviderContext from ._model._identity import ProjectIdentity from ._model._inputs import Settings @@ -36,6 +36,7 @@ "IdentityMethod", "License", "LicenseInfo", + "MissingExtraError", "OrganizationalEntity", "ProjectIdentity", "Property", diff --git a/src/python_sbom/_cli/_main.py b/src/python_sbom/_cli/_main.py index 8888134..5ddc542 100644 --- a/src/python_sbom/_cli/_main.py +++ b/src/python_sbom/_cli/_main.py @@ -4,7 +4,7 @@ import sys from typing import TYPE_CHECKING -from python_sbom._errors import SbomError +from python_sbom import SbomError from ._parser import build_parser diff --git a/src/python_sbom/_cli/_spdx.py b/src/python_sbom/_cli/_spdx.py index 898ed22..5afabc2 100644 --- a/src/python_sbom/_cli/_spdx.py +++ b/src/python_sbom/_cli/_spdx.py @@ -2,7 +2,7 @@ from typing import TYPE_CHECKING, Protocol -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._formats._json import dumps, is_document, load_json from python_sbom._formats._spdx import render_spdx from python_sbom._validate._limits import MAX_COMPONENTS, byte_limit diff --git a/src/python_sbom/_collect/_archive.py b/src/python_sbom/_collect/_archive.py index f11b47c..8eb0b22 100644 --- a/src/python_sbom/_collect/_archive.py +++ b/src/python_sbom/_collect/_archive.py @@ -2,7 +2,7 @@ from typing import TYPE_CHECKING, Final -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._archive import bundled_members from python_sbom._model._inputs import ArchiveTree, RecordRow from python_sbom._model._metadata import parse_metadata diff --git a/src/python_sbom/_collect/_content.py b/src/python_sbom/_collect/_content.py index 5bfed7e..dbd58e2 100644 --- a/src/python_sbom/_collect/_content.py +++ b/src/python_sbom/_collect/_content.py @@ -7,7 +7,7 @@ from pathlib import Path, PurePosixPath from typing import TYPE_CHECKING, Final -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._content import ContentProvider if TYPE_CHECKING: diff --git a/src/python_sbom/_collect/_facts.py b/src/python_sbom/_collect/_facts.py index d921d9a..217761c 100644 --- a/src/python_sbom/_collect/_facts.py +++ b/src/python_sbom/_collect/_facts.py @@ -16,7 +16,7 @@ from packaging.requirements import InvalidRequirement, Requirement from packaging.utils import canonicalize_name -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import BuildFacts, InstalledDistribution, Interpreter, RecordRow from python_sbom._model._metadata import parse_metadata from python_sbom._model._record import record_rows diff --git a/src/python_sbom/_collect/_revision.py b/src/python_sbom/_collect/_revision.py index 0dafdd2..f9b74d7 100644 --- a/src/python_sbom/_collect/_revision.py +++ b/src/python_sbom/_collect/_revision.py @@ -7,7 +7,7 @@ import warnings from typing import TYPE_CHECKING, Final, Protocol -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import Revision if TYPE_CHECKING: diff --git a/src/python_sbom/_collect/_settings.py b/src/python_sbom/_collect/_settings.py index 05c3676..6eacfc0 100644 --- a/src/python_sbom/_collect/_settings.py +++ b/src/python_sbom/_collect/_settings.py @@ -3,7 +3,7 @@ import tomllib from typing import TYPE_CHECKING, TypeAlias -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import Settings if TYPE_CHECKING: diff --git a/src/python_sbom/_collect/_source.py b/src/python_sbom/_collect/_source.py index a30b16e..9813059 100644 --- a/src/python_sbom/_collect/_source.py +++ b/src/python_sbom/_collect/_source.py @@ -3,7 +3,7 @@ from pathlib import PurePath from typing import TYPE_CHECKING, Final -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import BuildScript from python_sbom._wheel._zip import sha256_hex diff --git a/src/python_sbom/_collect/_wheel.py b/src/python_sbom/_collect/_wheel.py index 3a0fbd0..da896be 100644 --- a/src/python_sbom/_collect/_wheel.py +++ b/src/python_sbom/_collect/_wheel.py @@ -2,7 +2,7 @@ from typing import TYPE_CHECKING, Final -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import WheelTree from python_sbom._wheel._zip import read_wheel_metadata diff --git a/src/python_sbom/_errors.py b/src/python_sbom/_errors.py index b6e6ba1..8248783 100644 --- a/src/python_sbom/_errors.py +++ b/src/python_sbom/_errors.py @@ -6,7 +6,8 @@ class SbomError(Exception): # validation reports every other error per document, and lets this one through, since it fails every document alike -class MissingExtraError(SbomError): ... # simplint: ignore[SMP704] # see above +class MissingExtraError(SbomError): + """Raised when validation needs an optional dependency that is not installed.""" __all__ = [ diff --git a/src/python_sbom/_formats/_json.py b/src/python_sbom/_formats/_json.py index fd92b68..66ccedd 100644 --- a/src/python_sbom/_formats/_json.py +++ b/src/python_sbom/_formats/_json.py @@ -3,7 +3,7 @@ import json from typing import TYPE_CHECKING, Any, TypeAlias -from python_sbom._errors import SbomError +from python_sbom import SbomError if TYPE_CHECKING: from typing import TypeIs # new in 3.13; annotations here are never evaluated diff --git a/src/python_sbom/_generate/_archive.py b/src/python_sbom/_generate/_archive.py index cd55593..7011f51 100644 --- a/src/python_sbom/_generate/_archive.py +++ b/src/python_sbom/_generate/_archive.py @@ -2,13 +2,13 @@ from typing import TYPE_CHECKING +from python_sbom import SbomError from python_sbom._collect._archive import read_archive from python_sbom._collect._content import resolve_provider from python_sbom._collect._facts import collect_facts from python_sbom._collect._revision import revision_reader from python_sbom._collect._settings import settings_from_pyproject from python_sbom._collect._source import copyright_notice, hash_build_scripts -from python_sbom._errors import SbomError from python_sbom._formats._json import dumps from python_sbom._model._archive import archive_artifact, bundled_paths from python_sbom._model._bom import assemble, checked_contributions diff --git a/src/python_sbom/_model/_bom.py b/src/python_sbom/_model/_bom.py index a2820b2..92c5072 100644 --- a/src/python_sbom/_model/_bom.py +++ b/src/python_sbom/_model/_bom.py @@ -7,7 +7,7 @@ from typing import TYPE_CHECKING, Final from urllib.parse import urlsplit -from python_sbom._errors import SbomError +from python_sbom import SbomError from ._graph import reference_problems, walk_components from ._names import SBOM_FILE, SBOM_REPOSITORY, sbom_property diff --git a/src/python_sbom/_model/_record.py b/src/python_sbom/_model/_record.py index 9f7de64..a255482 100644 --- a/src/python_sbom/_model/_record.py +++ b/src/python_sbom/_model/_record.py @@ -7,7 +7,7 @@ from installer.records import RecordEntry -from python_sbom._errors import SbomError +from python_sbom import SbomError from ._inputs import RecordRow diff --git a/src/python_sbom/_validate/_document.py b/src/python_sbom/_validate/_document.py index 2c041a7..dd58f67 100644 --- a/src/python_sbom/_validate/_document.py +++ b/src/python_sbom/_validate/_document.py @@ -5,7 +5,7 @@ from importlib.util import find_spec from typing import TYPE_CHECKING, Final -from python_sbom._errors import MissingExtraError, SbomError +from python_sbom import MissingExtraError, SbomError from python_sbom._formats._json import Json, has_path, is_document, load_json from python_sbom._formats._spdx import render_spdx from python_sbom._model._graph import artifact_contents, reference_problems, repeated, walk_components diff --git a/src/python_sbom/_wheel/_bundled.py b/src/python_sbom/_wheel/_bundled.py index c0a22f0..3419a3a 100644 --- a/src/python_sbom/_wheel/_bundled.py +++ b/src/python_sbom/_wheel/_bundled.py @@ -8,7 +8,7 @@ from installer.sources import WheelFile from packaging.requirements import InvalidRequirement, Requirement -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import BundledWheel, RecordRow from python_sbom._model._metadata import CoreMetadata, parse_metadata from python_sbom._model._record import record_rows diff --git a/src/python_sbom/_wheel/_sdist.py b/src/python_sbom/_wheel/_sdist.py index 9532f37..cbd93bb 100644 --- a/src/python_sbom/_wheel/_sdist.py +++ b/src/python_sbom/_wheel/_sdist.py @@ -9,7 +9,7 @@ from pathlib import Path from typing import Final -from python_sbom._errors import SbomError +from python_sbom import SbomError def add_to_sdist(sdist: Path, name: str, content: bytes) -> None: diff --git a/src/python_sbom/_wheel/_write.py b/src/python_sbom/_wheel/_write.py index fca97bf..c01836f 100644 --- a/src/python_sbom/_wheel/_write.py +++ b/src/python_sbom/_wheel/_write.py @@ -15,7 +15,7 @@ from installer.records import Hash, RecordEntry from installer.utils import copyfileobj_with_hashing -from python_sbom._errors import SbomError +from python_sbom import SbomError from ._zip import open_archive, wheel_source diff --git a/src/python_sbom/_wheel/_zip.py b/src/python_sbom/_wheel/_zip.py index 322f0f0..ed0e0a7 100644 --- a/src/python_sbom/_wheel/_zip.py +++ b/src/python_sbom/_wheel/_zip.py @@ -9,7 +9,7 @@ from installer.sources import WheelFile -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._metadata import CoreMetadata, parse_metadata if TYPE_CHECKING: diff --git a/src/python_sbom/hatch/_hook.py b/src/python_sbom/hatch/_hook.py index 7bbb9d8..5590a0f 100644 --- a/src/python_sbom/hatch/_hook.py +++ b/src/python_sbom/hatch/_hook.py @@ -11,10 +11,10 @@ from hatchling.builders.utils import get_reproducible_timestamp from hatchling.utils.constants import DEFAULT_BUILD_SCRIPT +from python_sbom import SbomError from python_sbom._collect._content import resolve_provider from python_sbom._collect._revision import REVISION_FILE, default_revision, revision_record from python_sbom._collect._settings import settings_from_table -from python_sbom._errors import SbomError if TYPE_CHECKING: from collections.abc import Callable diff --git a/tests/_collect/test_content.py b/tests/_collect/test_content.py index 9709b64..33d5a37 100644 --- a/tests/_collect/test_content.py +++ b/tests/_collect/test_content.py @@ -8,9 +8,8 @@ import pytest import python_sbom -from python_sbom import ContentProvider +from python_sbom import ContentProvider, SbomError from python_sbom._collect._content import resolve_provider -from python_sbom._errors import SbomError if TYPE_CHECKING: from python_sbom import Settings diff --git a/tests/_collect/test_facts.py b/tests/_collect/test_facts.py index ac54dc6..48c7f0c 100644 --- a/tests/_collect/test_facts.py +++ b/tests/_collect/test_facts.py @@ -9,8 +9,8 @@ import pytest +from python_sbom import SbomError from python_sbom._collect._facts import collect_facts -from python_sbom._errors import SbomError from python_sbom._model._inputs import Interpreter, RecordRow, Revision if TYPE_CHECKING: diff --git a/tests/_collect/test_revision.py b/tests/_collect/test_revision.py index e6f23ed..ffbff10 100644 --- a/tests/_collect/test_revision.py +++ b/tests/_collect/test_revision.py @@ -4,8 +4,8 @@ import pytest +from python_sbom import SbomError from python_sbom._collect._revision import REVISION_FILE, default_revision, revision_reader -from python_sbom._errors import SbomError from python_sbom._model._inputs import Revision if TYPE_CHECKING: diff --git a/tests/_collect/test_settings.py b/tests/_collect/test_settings.py index a1776d5..9d78358 100644 --- a/tests/_collect/test_settings.py +++ b/tests/_collect/test_settings.py @@ -4,8 +4,8 @@ import pytest +from python_sbom import SbomError from python_sbom._collect._settings import settings_from_pyproject, settings_from_table -from python_sbom._errors import SbomError from python_sbom._model._inputs import Settings if TYPE_CHECKING: diff --git a/tests/_collect/test_source.py b/tests/_collect/test_source.py index 5968cad..e0f4dc0 100644 --- a/tests/_collect/test_source.py +++ b/tests/_collect/test_source.py @@ -8,8 +8,8 @@ import pytest +from python_sbom import SbomError from python_sbom._collect._source import copyright_notice, hash_build_scripts, selected_wheels -from python_sbom._errors import SbomError from python_sbom._model._inputs import BuildScript if TYPE_CHECKING: diff --git a/tests/_collect/test_wheel.py b/tests/_collect/test_wheel.py index cd3dd19..3525854 100644 --- a/tests/_collect/test_wheel.py +++ b/tests/_collect/test_wheel.py @@ -7,8 +7,8 @@ import pytest +from python_sbom import SbomError from python_sbom._collect._wheel import read_wheel -from python_sbom._errors import SbomError from python_sbom._model._inputs import BuildScript, WheelTree from python_sbom._wheel._reader import open_artifact diff --git a/tests/_generate/test_archive.py b/tests/_generate/test_archive.py index 960528e..2145d2f 100644 --- a/tests/_generate/test_archive.py +++ b/tests/_generate/test_archive.py @@ -9,10 +9,9 @@ import pytest -from python_sbom import BundledWheelInfo, ContentProvider, Contributions, ProviderContext +from python_sbom import BundledWheelInfo, ContentProvider, Contributions, ProviderContext, SbomError from python_sbom._collect._facts import collect_facts from python_sbom._collect._revision import revision_reader -from python_sbom._errors import SbomError from python_sbom._generate._archive import describe_archive from python_sbom._model._inputs import Revision from python_sbom._validate._artifact import validate diff --git a/tests/_model/test_bom.py b/tests/_model/test_bom.py index 3ed30d0..ad17d84 100644 --- a/tests/_model/test_bom.py +++ b/tests/_model/test_bom.py @@ -8,8 +8,7 @@ import pytest -from python_sbom import BundledWheelInfo, ContentProvider, Contributions, ProviderContext -from python_sbom._errors import SbomError +from python_sbom import BundledWheelInfo, ContentProvider, Contributions, ProviderContext, SbomError from python_sbom._model._bom import ( check_refs, checked_contributions, diff --git a/tests/_model/test_record.py b/tests/_model/test_record.py index 4266c89..b28978c 100644 --- a/tests/_model/test_record.py +++ b/tests/_model/test_record.py @@ -4,7 +4,7 @@ import pytest -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import RecordRow from python_sbom._model._record import record_rows diff --git a/tests/_validate/test_artifact.py b/tests/_validate/test_artifact.py index 55c7948..9b4005e 100644 --- a/tests/_validate/test_artifact.py +++ b/tests/_validate/test_artifact.py @@ -7,7 +7,7 @@ import pytest -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._formats._json import dumps from python_sbom._validate._artifact import validate diff --git a/tests/_validate/test_schemas.py b/tests/_validate/test_schemas.py index 9cf6bfe..6d69f34 100644 --- a/tests/_validate/test_schemas.py +++ b/tests/_validate/test_schemas.py @@ -9,7 +9,7 @@ from spdx_tools.spdx.parser.jsonlikedict.json_like_dict_parser import JsonLikeDictParser from spdx_tools.spdx.validation.document_validator import validate_full_spdx_document -from python_sbom._errors import MissingExtraError +from python_sbom import MissingExtraError from python_sbom._formats._json import dumps from python_sbom._formats._spdx import render_spdx from python_sbom._validate._document import validate_document diff --git a/tests/_wheel/test_bundled.py b/tests/_wheel/test_bundled.py index d05a42f..da86cf7 100644 --- a/tests/_wheel/test_bundled.py +++ b/tests/_wheel/test_bundled.py @@ -10,7 +10,7 @@ import pytest -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._model._inputs import BundledWheel, RecordRow from python_sbom._wheel._bundled import read_bundled_wheels diff --git a/tests/_wheel/test_reader.py b/tests/_wheel/test_reader.py index c8d5bf4..683185e 100644 --- a/tests/_wheel/test_reader.py +++ b/tests/_wheel/test_reader.py @@ -6,7 +6,7 @@ import pytest -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._wheel._reader import open_artifact diff --git a/tests/_wheel/test_write.py b/tests/_wheel/test_write.py index 1f555f4..01c9a14 100644 --- a/tests/_wheel/test_write.py +++ b/tests/_wheel/test_write.py @@ -10,7 +10,7 @@ import pytest -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._wheel._write import append_member, write_sbom if TYPE_CHECKING: diff --git a/tests/_wheel/test_zip.py b/tests/_wheel/test_zip.py index 297dcc2..fe9777e 100644 --- a/tests/_wheel/test_zip.py +++ b/tests/_wheel/test_zip.py @@ -10,7 +10,7 @@ import pytest -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._wheel._zip import open_archive, read_member, sha256_hex if TYPE_CHECKING: diff --git a/tests/hatch/test_hook.py b/tests/hatch/test_hook.py index d14ef87..5ee5173 100644 --- a/tests/hatch/test_hook.py +++ b/tests/hatch/test_hook.py @@ -11,7 +11,7 @@ import pytest -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._validate._artifact import validate if TYPE_CHECKING: diff --git a/tests/test_backend.py b/tests/test_backend.py index f94d7c0..1addbdd 100644 --- a/tests/test_backend.py +++ b/tests/test_backend.py @@ -9,8 +9,7 @@ import flit_core.buildapi import pytest -from python_sbom import backend -from python_sbom._errors import SbomError +from python_sbom import SbomError, backend from python_sbom._validate._artifact import validate if TYPE_CHECKING: diff --git a/tests/test_public_api.py b/tests/test_public_api.py index 8286e1c..45efe2f 100644 --- a/tests/test_public_api.py +++ b/tests/test_public_api.py @@ -36,6 +36,7 @@ "IdentityMethod", "License", "LicenseInfo", + "MissingExtraError", "OrganizationalEntity", "ProjectIdentity", "Property", diff --git a/tests/test_setuptools.py b/tests/test_setuptools.py index cf26aee..ff3188f 100644 --- a/tests/test_setuptools.py +++ b/tests/test_setuptools.py @@ -9,7 +9,7 @@ from setuptools import build_meta from setuptools.dist import Distribution -from python_sbom._errors import SbomError +from python_sbom import SbomError from python_sbom._validate._artifact import validate from python_sbom.setuptools import finalize_distribution_options