/usr/lib/python3/dist-packages/pyramid/config/assets.py is in python3-pyramid 1.6+dfsg-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | import os
import pkg_resources
import sys
from zope.interface import implementer
from pyramid.interfaces import IPackageOverrides
from pyramid.exceptions import ConfigurationError
from pyramid.threadlocal import get_current_registry
from pyramid.util import action_method
class OverrideProvider(pkg_resources.DefaultProvider):
def __init__(self, module):
pkg_resources.DefaultProvider.__init__(self, module)
self.module_name = module.__name__
def _get_overrides(self):
reg = get_current_registry()
overrides = reg.queryUtility(IPackageOverrides, self.module_name)
return overrides
def get_resource_filename(self, manager, resource_name):
""" Return a true filesystem path for resource_name,
co-ordinating the extraction with manager, if the resource
must be unpacked to the filesystem.
"""
overrides = self._get_overrides()
if overrides is not None:
filename = overrides.get_filename(resource_name)
if filename is not None:
return filename
return pkg_resources.DefaultProvider.get_resource_filename(
self, manager, resource_name)
def get_resource_stream(self, manager, resource_name):
""" Return a readable file-like object for resource_name."""
overrides = self._get_overrides()
if overrides is not None:
stream = overrides.get_stream(resource_name)
if stream is not None:
return stream
return pkg_resources.DefaultProvider.get_resource_stream(
self, manager, resource_name)
def get_resource_string(self, manager, resource_name):
""" Return a string containing the contents of resource_name."""
overrides = self._get_overrides()
if overrides is not None:
string = overrides.get_string(resource_name)
if string is not None:
return string
return pkg_resources.DefaultProvider.get_resource_string(
self, manager, resource_name)
def has_resource(self, resource_name):
overrides = self._get_overrides()
if overrides is not None:
result = overrides.has_resource(resource_name)
if result is not None:
return result
return pkg_resources.DefaultProvider.has_resource(
self, resource_name)
def resource_isdir(self, resource_name):
overrides = self._get_overrides()
if overrides is not None:
result = overrides.isdir(resource_name)
if result is not None:
return result
return pkg_resources.DefaultProvider.resource_isdir(
self, resource_name)
def resource_listdir(self, resource_name):
overrides = self._get_overrides()
if overrides is not None:
result = overrides.listdir(resource_name)
if result is not None:
return result
return pkg_resources.DefaultProvider.resource_listdir(
self, resource_name)
@implementer(IPackageOverrides)
class PackageOverrides(object):
# pkg_resources arg in kw args below for testing
def __init__(self, package, pkg_resources=pkg_resources):
loader = self._real_loader = getattr(package, '__loader__', None)
if isinstance(loader, self.__class__):
self._real_loader = None
# We register ourselves as a __loader__ *only* to support the
# setuptools _find_adapter adapter lookup; this class doesn't
# actually support the PEP 302 loader "API". This is
# excusable due to the following statement in the spec:
# ... Loader objects are not
# required to offer any useful functionality (any such functionality,
# such as the zipimport get_data() method mentioned above, is
# optional)...
# A __loader__ attribute is basically metadata, and setuptools
# uses it as such.
package.__loader__ = self
# we call register_loader_type for every instantiation of this
# class; that's OK, it's idempotent to do it more than once.
pkg_resources.register_loader_type(self.__class__, OverrideProvider)
self.overrides = []
self.overridden_package_name = package.__name__
def insert(self, path, source):
if not path or path.endswith('/'):
override = DirectoryOverride(path, source)
else:
override = FileOverride(path, source)
self.overrides.insert(0, override)
return override
def filtered_sources(self, resource_name):
for override in self.overrides:
o = override(resource_name)
if o is not None:
yield o
def get_filename(self, resource_name):
for source, path in self.filtered_sources(resource_name):
result = source.get_filename(path)
if result is not None:
return result
def get_stream(self, resource_name):
for source, path in self.filtered_sources(resource_name):
result = source.get_stream(path)
if result is not None:
return result
def get_string(self, resource_name):
for source, path in self.filtered_sources(resource_name):
result = source.get_string(path)
if result is not None:
return result
def has_resource(self, resource_name):
for source, path in self.filtered_sources(resource_name):
if source.exists(path):
return True
def isdir(self, resource_name):
for source, path in self.filtered_sources(resource_name):
result = source.isdir(path)
if result is not None:
return result
def listdir(self, resource_name):
for source, path in self.filtered_sources(resource_name):
result = source.listdir(path)
if result is not None:
return result
@property
def real_loader(self):
if self._real_loader is None:
raise NotImplementedError()
return self._real_loader
def get_data(self, path):
""" See IPEP302Loader.
"""
return self.real_loader.get_data(path)
def is_package(self, fullname):
""" See IPEP302Loader.
"""
return self.real_loader.is_package(fullname)
def get_code(self, fullname):
""" See IPEP302Loader.
"""
return self.real_loader.get_code(fullname)
def get_source(self, fullname):
""" See IPEP302Loader.
"""
return self.real_loader.get_source(fullname)
class DirectoryOverride:
def __init__(self, path, source):
self.path = path
self.pathlen = len(self.path)
self.source = source
def __call__(self, resource_name):
if resource_name.startswith(self.path):
new_path = resource_name[self.pathlen:]
return self.source, new_path
class FileOverride:
def __init__(self, path, source):
self.path = path
self.source = source
def __call__(self, resource_name):
if resource_name == self.path:
return self.source, ''
class PackageAssetSource(object):
"""
An asset source relative to a package.
If this asset source is a file, then we expect the ``prefix`` to point
to the new name of the file, and the incoming ``resource_name`` will be
the empty string, as returned by the ``FileOverride``.
"""
def __init__(self, package, prefix):
self.package = package
if hasattr(package, '__name__'):
self.pkg_name = package.__name__
else:
self.pkg_name = package
self.prefix = prefix
def get_path(self, resource_name):
return '%s%s' % (self.prefix, resource_name)
def get_filename(self, resource_name):
path = self.get_path(resource_name)
if pkg_resources.resource_exists(self.pkg_name, path):
return pkg_resources.resource_filename(self.pkg_name, path)
def get_stream(self, resource_name):
path = self.get_path(resource_name)
if pkg_resources.resource_exists(self.pkg_name, path):
return pkg_resources.resource_stream(self.pkg_name, path)
def get_string(self, resource_name):
path = self.get_path(resource_name)
if pkg_resources.resource_exists(self.pkg_name, path):
return pkg_resources.resource_string(self.pkg_name, path)
def exists(self, resource_name):
path = self.get_path(resource_name)
if pkg_resources.resource_exists(self.pkg_name, path):
return True
def isdir(self, resource_name):
path = self.get_path(resource_name)
if pkg_resources.resource_exists(self.pkg_name, path):
return pkg_resources.resource_isdir(self.pkg_name, path)
def listdir(self, resource_name):
path = self.get_path(resource_name)
if pkg_resources.resource_exists(self.pkg_name, path):
return pkg_resources.resource_listdir(self.pkg_name, path)
class FSAssetSource(object):
"""
An asset source relative to a path in the filesystem.
"""
def __init__(self, prefix):
self.prefix = prefix
def get_path(self, resource_name):
if resource_name:
path = os.path.join(self.prefix, resource_name)
else:
path = self.prefix
return path
def get_filename(self, resource_name):
path = self.get_path(resource_name)
if os.path.exists(path):
return path
def get_stream(self, resource_name):
path = self.get_filename(resource_name)
if path is not None:
return open(path, 'rb')
def get_string(self, resource_name):
stream = self.get_stream(resource_name)
if stream is not None:
with stream:
return stream.read()
def exists(self, resource_name):
path = self.get_filename(resource_name)
if path is not None:
return True
def isdir(self, resource_name):
path = self.get_filename(resource_name)
if path is not None:
return os.path.isdir(path)
def listdir(self, resource_name):
path = self.get_filename(resource_name)
if path is not None:
return os.listdir(path)
class AssetsConfiguratorMixin(object):
def _override(self, package, path, override_source,
PackageOverrides=PackageOverrides):
pkg_name = package.__name__
override = self.registry.queryUtility(IPackageOverrides, name=pkg_name)
if override is None:
override = PackageOverrides(package)
self.registry.registerUtility(override, IPackageOverrides,
name=pkg_name)
override.insert(path, override_source)
@action_method
def override_asset(self, to_override, override_with, _override=None):
""" Add a :app:`Pyramid` asset override to the current
configuration state.
``to_override`` is an :term:`asset specification` to the
asset being overridden.
``override_with`` is an :term:`asset specification` to the
asset that is performing the override. This may also be an absolute
path.
See :ref:`assets_chapter` for more
information about asset overrides."""
if to_override == override_with:
raise ConfigurationError(
'You cannot override an asset with itself')
package = to_override
path = ''
if ':' in to_override:
package, path = to_override.split(':', 1)
# *_isdir = override is package or directory
overridden_isdir = path == '' or path.endswith('/')
if os.path.isabs(override_with):
override_source = FSAssetSource(override_with)
if not os.path.exists(override_with):
raise ConfigurationError(
'Cannot override asset with an absolute path that does '
'not exist')
override_isdir = os.path.isdir(override_with)
override_package = None
override_prefix = override_with
else:
override_package = override_with
override_prefix = ''
if ':' in override_with:
override_package, override_prefix = override_with.split(':', 1)
__import__(override_package)
to_package = sys.modules[override_package]
override_source = PackageAssetSource(to_package, override_prefix)
override_isdir = (
override_prefix == '' or
override_with.endswith('/')
)
if overridden_isdir and (not override_isdir):
raise ConfigurationError(
'A directory cannot be overridden with a file (put a '
'slash at the end of override_with if necessary)')
if (not overridden_isdir) and override_isdir:
raise ConfigurationError(
'A file cannot be overridden with a directory (put a '
'slash at the end of to_override if necessary)')
override = _override or self._override # test jig
def register():
__import__(package)
from_package = sys.modules[package]
override(from_package, path, override_source)
intr = self.introspectable(
'asset overrides',
(package, override_package, path, override_prefix),
'%s -> %s' % (to_override, override_with),
'asset override',
)
intr['to_override'] = to_override
intr['override_with'] = override_with
self.action(None, register, introspectables=(intr,))
override_resource = override_asset # bw compat
|