From 01292859d814fc8f175a16d117353a8c925abe4c Mon Sep 17 00:00:00 2001 From: Felipe Fumero Date: Sat, 21 Nov 2026 14:31:33 -0600 Subject: [PATCH] fix: fall back when package version metadata is unavailable --- b2sdk/version.py | 6 +++- .../+version-metadata-fallback.fixed.md | 1 + test/static/test_regression_repo_checks.py | 11 ++----- test/unit/test_version.py | 30 +++++++++++++++++++ 4 files changed, 39 insertions(+), 9 deletions(-) create mode 100644 changelog.d/+version-metadata-fallback.fixed.md create mode 100644 test/unit/test_version.py diff --git a/b2sdk/version.py b/b2sdk/version.py index 241bce2ec..26d80f488 100644 --- a/b2sdk/version.py +++ b/b2sdk/version.py @@ -9,6 +9,7 @@ ###################################################################### from __future__ import annotations +from importlib.metadata import PackageNotFoundError from importlib.metadata import version as _version from sys import version_info as _version_info @@ -18,7 +19,10 @@ 'USER_AGENT', ] -VERSION = _version('b2sdk') +try: + VERSION = _version('b2sdk') +except PackageNotFoundError: + VERSION = '0.0.0+unknown' PYTHON_VERSION = '.'.join(map(str, _version_info[:3])) # something like: 3.9.1 diff --git a/changelog.d/+version-metadata-fallback.fixed.md b/changelog.d/+version-metadata-fallback.fixed.md new file mode 100644 index 000000000..d1e20db45 --- /dev/null +++ b/changelog.d/+version-metadata-fallback.fixed.md @@ -0,0 +1 @@ +Fix importing vendored or uninstalled copies of the SDK by using a fallback version when package metadata is unavailable. diff --git a/test/static/test_regression_repo_checks.py b/test/static/test_regression_repo_checks.py index 0fe61c387..0199a8adf 100644 --- a/test/static/test_regression_repo_checks.py +++ b/test/static/test_regression_repo_checks.py @@ -28,7 +28,7 @@ import pytest -from test.known_defect import DefectStillPresent, expect, known_defect +from test.known_defect import known_defect ROOT = Path(__file__).resolve().parents[2] @@ -52,11 +52,6 @@ def test_c59_readme_mentions_full_extra(): assert re.search(r'b2sdk\[full\]', _read('README.md')), 'README does not mention b2sdk[full]' -@known_defect( - 'C36', - 'importing b2sdk fails when the package metadata is not installed', - raises=DefectStillPresent, -) def test_c36_version_import_works_when_package_metadata_is_missing(tmp_path): """C36: importing a vendored/uninstalled copy of b2sdk must not fail for missing dist metadata.""" script = textwrap.dedent( @@ -70,11 +65,11 @@ def fake(name): m.version = fake sys.path.insert(0, {str(ROOT)!r}) import b2sdk.version + assert b2sdk.__version__ == b2sdk.version.VERSION + assert b2sdk.version.VERSION """ ) result = subprocess.run( [sys.executable, '-c', script], capture_output=True, text=True, cwd=tmp_path ) - # only the missing-metadata error is the defect; any other failure is a real failure - expect('PackageNotFoundError' not in result.stderr, result.stderr[-300:]) assert result.returncode == 0, result.stderr[-300:] diff --git a/test/unit/test_version.py b/test/unit/test_version.py new file mode 100644 index 000000000..39921a213 --- /dev/null +++ b/test/unit/test_version.py @@ -0,0 +1,30 @@ +###################################################################### +# +# File: test/unit/test_version.py +# +# Copyright 2026 Backblaze Inc. All Rights Reserved. +# +# License https://www.backblaze.com/using_b2_code.html +# +###################################################################### +from __future__ import annotations + +import importlib.util +from importlib.metadata import PackageNotFoundError +from pathlib import Path +from unittest.mock import patch + +from packaging.version import Version + + +def test_version_import_without_package_metadata(): + spec = importlib.util.spec_from_file_location( + 'version_under_test', Path(__file__).resolve().parents[2] / 'b2sdk' / 'version.py' + ) + module = importlib.util.module_from_spec(spec) + with patch('importlib.metadata.version', side_effect=PackageNotFoundError('b2sdk')): + spec.loader.exec_module(module) + + assert module.VERSION + assert str(Version(module.VERSION)) == module.VERSION + assert module.USER_AGENT == f'backblaze-b2/{module.VERSION} python/{module.PYTHON_VERSION}'