From 832cae47693b4c07a1fa826dce13b9af7a91ebaf Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 24 Aug 2025 21:35:04 -0700 Subject: Add `get_spec` to asset sources. --- src/pyramid/config/assets.py | 8 ++++++++ tests/test_config/test_assets.py | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/src/pyramid/config/assets.py b/src/pyramid/config/assets.py index 6f2ddbe4a..2838db1e5 100644 --- a/src/pyramid/config/assets.py +++ b/src/pyramid/config/assets.py @@ -223,6 +223,11 @@ class PackageAssetSource: def get_path(self, resource_name): return f'{self.prefix}{resource_name}' + def get_spec(self, resource_name): + path = self.get_path(resource_name) + if pkg_resources.resource_exists(self.pkg_name, path): + return f'{self.pkg_name}:{path}' + def get_filename(self, resource_name): path = self.get_path(resource_name) if pkg_resources.resource_exists(self.pkg_name, path): @@ -270,6 +275,9 @@ class FSAssetSource: path = self.prefix return path + def get_spec(self, resource_name): + return self.get_filename(resource_name) + def get_filename(self, resource_name): path = self.get_path(resource_name) if os.path.exists(path): diff --git a/tests/test_config/test_assets.py b/tests/test_config/test_assets.py index 1d2cfcd5c..5c535ec6c 100644 --- a/tests/test_config/test_assets.py +++ b/tests/test_config/test_assets.py @@ -916,6 +916,24 @@ class TestPackageAssetSource(AssetSourceIntegrationTests, unittest.TestCase): klass = self._getTargetClass() return klass(package, prefix) + def test_get_spec(self): + source = self._makeOne('') + self.assertEqual( + source.get_spec('test_assets.py'), + 'tests.test_config:test_assets.py', + ) + + def test_get_spec_with_prefix(self): + source = self._makeOne('test_assets.py') + self.assertEqual( + source.get_spec(''), + 'tests.test_config:test_assets.py', + ) + + def test_get_spec_file_doesnt_exist(self): + source = self._makeOne('') + self.assertIsNone(source.get_spec('wont_exist')) + class TestFSAssetSource(AssetSourceIntegrationTests, unittest.TestCase): def _getTargetClass(self): @@ -927,6 +945,23 @@ class TestFSAssetSource(AssetSourceIntegrationTests, unittest.TestCase): klass = self._getTargetClass() return klass(os.path.join(base_prefix, prefix)) + def test_get_spec(self): + source = self._makeOne('') + self.assertEqual( + source.get_spec('test_assets.py'), + os.path.join(here, 'test_assets.py'), + ) + + def test_get_spec_with_prefix(self): + source = self._makeOne('test_assets.py') + self.assertEqual( + source.get_spec(''), os.path.join(here, 'test_assets.py') + ) + + def test_get_spec_file_doesnt_exist(self): + source = self._makeOne('') + self.assertEqual(source.get_spec('wont_exist'), None) + class TestDirectoryOverride(unittest.TestCase): def _getTargetClass(self): -- cgit v1.2.3 From 9b9ac95c7207a5b0a5c2fd7ef56977e9b285f206 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 24 Aug 2025 21:38:56 -0700 Subject: Add `get_spec` to `PackageOverrides` --- src/pyramid/config/assets.py | 6 ++++++ tests/test_config/test_assets.py | 26 ++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/src/pyramid/config/assets.py b/src/pyramid/config/assets.py index 2838db1e5..3c6a8d360 100644 --- a/src/pyramid/config/assets.py +++ b/src/pyramid/config/assets.py @@ -122,6 +122,12 @@ class PackageOverrides: if o is not None: yield o + def get_spec(self, resource_name): + for source, path in self.filtered_sources(resource_name): + result = source.get_spec(path) + if result is not None: + return result + def get_filename(self, resource_name): for source, path in self.filtered_sources(resource_name): result = source.get_filename(path) diff --git a/tests/test_config/test_assets.py b/tests/test_config/test_assets.py index 5c535ec6c..ea2fff741 100644 --- a/tests/test_config/test_assets.py +++ b/tests/test_config/test_assets.py @@ -638,6 +638,28 @@ class TestPackageOverrides(unittest.TestCase): po.overrides = overrides self.assertEqual(list(po.filtered_sources('whatever')), ['foo']) + def test_get_spec(self): + source = DummyAssetSource(spec='test:foo.pt') + overrides = [DummyOverride(None), DummyOverride((source, ''))] + package = DummyPackage('package') + po = self._makeOne(package) + po.overrides = overrides + result = po.get_spec('whatever') + self.assertEqual(result, 'test:foo.pt') + self.assertEqual(source.resource_name, '') + + def test_get_spec_file_doesnt_exist(self): + source = DummyAssetSource(spec=None) + overrides = [ + DummyOverride(None), + DummyOverride((source, 'wont_exist')), + ] + package = DummyPackage('package') + po = self._makeOne(package) + po.overrides = overrides + self.assertEqual(po.get_spec('whatever'), None) + self.assertEqual(source.resource_name, 'wont_exist') + def test_get_filename(self): source = DummyAssetSource(filename='foo.pt') overrides = [DummyOverride(None), DummyOverride((source, ''))] @@ -1053,6 +1075,10 @@ class DummyAssetSource: def __init__(self, **kw): self.kw = kw + def get_spec(self, resource_name): + self.resource_name = resource_name + return self.kw['spec'] + def get_filename(self, resource_name): self.resource_name = resource_name return self.kw['filename'] -- cgit v1.2.3 From ed315c142c7f66f6ee9ff24f4bad6997b0b45bfb Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 24 Aug 2025 21:42:18 -0700 Subject: Add `get_spec` to `IPackageOverrides` --- src/pyramid/interfaces.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/pyramid/interfaces.py b/src/pyramid/interfaces.py index 4ee294189..063b0385e 100644 --- a/src/pyramid/interfaces.py +++ b/src/pyramid/interfaces.py @@ -1079,6 +1079,14 @@ class IPEP302Loader(Interface): class IPackageOverrides(IPEP302Loader): """Utility for pkg_resources overrides""" + def get_spec(resource_name): + """Return a specifier for the resource. + + The specifier may be a dotted Python name or an absolute path on the + filesystem. + + """ + # VH_ROOT_KEY is an interface; its imported from other packages (e.g. # traversalwrapper) -- cgit v1.2.3 From eded8c0293b19f5b5f214fca91ba4152d63fce0d Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 24 Aug 2025 22:01:27 -0700 Subject: Update tests. --- tests/test_config/pkgs/cachebust/__init__.py | 0 tests/test_config/pkgs/cachebust/override/foo.png | Bin 0 -> 72 bytes tests/test_config/pkgs/cachebust/path/foo.png | Bin 0 -> 72 bytes tests/test_config/test_views.py | 25 ++++++++++++++++------ 4 files changed, 19 insertions(+), 6 deletions(-) create mode 100644 tests/test_config/pkgs/cachebust/__init__.py create mode 100644 tests/test_config/pkgs/cachebust/override/foo.png create mode 100644 tests/test_config/pkgs/cachebust/path/foo.png diff --git a/tests/test_config/pkgs/cachebust/__init__.py b/tests/test_config/pkgs/cachebust/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/test_config/pkgs/cachebust/override/foo.png b/tests/test_config/pkgs/cachebust/override/foo.png new file mode 100644 index 000000000..1cc2f763c Binary files /dev/null and b/tests/test_config/pkgs/cachebust/override/foo.png differ diff --git a/tests/test_config/pkgs/cachebust/path/foo.png b/tests/test_config/pkgs/cachebust/path/foo.png new file mode 100644 index 000000000..43440f881 Binary files /dev/null and b/tests/test_config/pkgs/cachebust/path/foo.png differ diff --git a/tests/test_config/test_views.py b/tests/test_config/test_views.py index 2018e61f2..ce7038b5d 100644 --- a/tests/test_config/test_views.py +++ b/tests/test_config/test_views.py @@ -4065,9 +4065,12 @@ class TestStaticURLInfo(unittest.TestCase): config = testing.setUp() try: request = testing.DummyRequest() - config.add_static_view('static', 'path') + config.add_static_view( + 'static', 'tests.test_config.pkgs.cachebust:path/' + ) config.override_asset( - 'tests.test_config:path/', 'tests.test_config:other_path/' + 'tests.test_config.pkgs.cachebust:path/', + 'tests.test_config.pkgs.cachebust:override/', ) def cb(val): @@ -4077,11 +4080,21 @@ class TestStaticURLInfo(unittest.TestCase): return cb_ - config.add_cache_buster('path', cb('foo')) - result = request.static_url('path/foo.png') + config.add_cache_buster( + 'tests.test_config.pkgs.cachebust:path/', cb('foo') + ) + result = request.static_url( + 'tests.test_config.pkgs.cachebust:path/foo.png' + ) self.assertEqual(result, 'http://example.com/static/foo.png?x=foo') - config.add_cache_buster('other_path', cb('bar'), explicit=True) - result = request.static_url('path/foo.png') + config.add_cache_buster( + 'tests.test_config.pkgs.cachebust:override/', + cb('bar'), + explicit=True, + ) + result = request.static_url( + 'tests.test_config.pkgs.cachebust:path/foo.png' + ) self.assertEqual(result, 'http://example.com/static/foo.png?x=bar') finally: testing.tearDown() -- cgit v1.2.3 From 73593a0d318121662de1ec56bfa838a390d45f96 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 24 Aug 2025 22:01:32 -0700 Subject: Update implementation. --- src/pyramid/config/views.py | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/src/pyramid/config/views.py b/src/pyramid/config/views.py index fababf542..302704c3e 100644 --- a/src/pyramid/config/views.py +++ b/src/pyramid/config/views.py @@ -2338,14 +2338,7 @@ class StaticURLInfo: pathspec = f'{pkg_name}:{pkg_subpath}{subpath}' overrides = registry.queryUtility(IPackageOverrides, name=pkg_name) if overrides is not None: - resource_name = posixpath.join(pkg_subpath, subpath) - sources = overrides.filtered_sources(resource_name) - for source, filtered_path in sources: - rawspec = source.get_path(filtered_path) - if hasattr(source, 'pkg_name'): - rawspec = f'{source.pkg_name}:{rawspec}' - break - + rawspec = overrides.get_spec(f'{pkg_subpath}{subpath}') else: pathspec = pkg_subpath + subpath @@ -2354,6 +2347,7 @@ class StaticURLInfo: kw['pathspec'] = pathspec kw['rawspec'] = rawspec + print(kw) for spec_, cachebust, explicit in reversed(self.cache_busters): if (explicit and rawspec.startswith(spec_)) or ( not explicit and pathspec.startswith(spec_) -- cgit v1.2.3