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 393 394 395 396 397 398 399 400
|
"""
Methods for getting and setting asdf global configuration
options.
"""
import copy
import threading
from contextlib import contextmanager
from . import entry_points, util, versioning
from ._helpers import validate_version
from .extension import ExtensionProxy
from .resource import ResourceManager, ResourceMappingProxy
__all__ = ["AsdfConfig", "get_config", "config_context"]
DEFAULT_VALIDATE_ON_READ = True
DEFAULT_DEFAULT_VERSION = str(versioning.default_version)
DEFAULT_LEGACY_FILL_SCHEMA_DEFAULTS = True
DEFAULT_IO_BLOCK_SIZE = -1 # auto
DEFAULT_ARRAY_INLINE_THRESHOLD = None
class AsdfConfig:
"""
Container for ASDF configuration options. Users are not intended to
construct this object directly; instead, use the `asdf.get_config` and
`asdf.config_context` module methods.
"""
def __init__(self):
self._resource_mappings = None
self._resource_manager = None
self._extensions = None
self._validate_on_read = DEFAULT_VALIDATE_ON_READ
self._default_version = DEFAULT_DEFAULT_VERSION
self._legacy_fill_schema_defaults = DEFAULT_LEGACY_FILL_SCHEMA_DEFAULTS
self._io_block_size = DEFAULT_IO_BLOCK_SIZE
self._array_inline_threshold = DEFAULT_ARRAY_INLINE_THRESHOLD
self._lock = threading.RLock()
@property
def resource_mappings(self):
"""
Get the list of registered resource mapping instances. Unless
overridden by user configuration, this list contains every mapping
registered with an entry point.
Returns
-------
list of asdf.resource.ResourceMappingProxy
"""
if self._resource_mappings is None:
with self._lock:
if self._resource_mappings is None:
self._resource_mappings = entry_points.get_resource_mappings()
return self._resource_mappings
def add_resource_mapping(self, mapping):
"""
Register a new resource mapping. The new mapping will
take precedence over all previously registered mappings.
Parameters
----------
mapping : collections.abc.Mapping
Map of `str` resource URI to `bytes` content
"""
with self._lock:
mapping = ResourceMappingProxy.maybe_wrap(mapping)
# Insert at the beginning of the list so that
# ResourceManager uses the new mapping first.
resource_mappings = [mapping] + [r for r in self.resource_mappings if r != mapping]
self._resource_mappings = resource_mappings
self._resource_manager = None
def remove_resource_mapping(self, mapping=None, *, package=None):
"""
Remove a registered resource mapping.
Parameters
----------
mapping : collections.abc.Mapping, optional
Mapping to remove.
package : str, optional
Remove only extensions provided by this package. If the ``mapping``
argument is omitted, then all mappings from this package will
be removed.
"""
if mapping is None and package is None:
raise ValueError("Must specify at least one of mapping or package")
if mapping is not None:
mapping = ResourceMappingProxy.maybe_wrap(mapping)
def _remove_condition(m):
result = True
if mapping is not None:
result = result and m == mapping
if package is not None:
result = result and m.package_name == package
return result
with self._lock:
self._resource_mappings = [m for m in self.resource_mappings if not _remove_condition(m)]
self._resource_manager = None
def reset_resources(self):
"""
Reset registered resource mappings to the default list
provided as entry points.
"""
with self._lock:
self._resource_mappings = None
self._resource_manager = None
@property
def resource_manager(self):
"""
Get the `asdf.resource.ResourceManager` instance. Includes resources from
registered resource mappings and any mappings added at runtime.
Returns
-------
`asdf.resource.ResourceManager`
"""
if self._resource_manager is None:
with self._lock:
if self._resource_manager is None:
self._resource_manager = ResourceManager(self.resource_mappings)
return self._resource_manager
@property
def extensions(self):
"""
Get the list of registered extensions.
Returns
-------
list of asdf.extension.ExtensionProxy
"""
if self._extensions is None:
with self._lock:
if self._extensions is None:
self._extensions = entry_points.get_extensions()
return self._extensions
def add_extension(self, extension):
"""
Register a new extension. The new extension will
take precedence over all previously registered extensions.
Parameters
----------
extension : asdf.extension.AsdfExtension or asdf.extension.Extension
"""
with self._lock:
extension = ExtensionProxy.maybe_wrap(extension)
self._extensions = [extension] + [e for e in self.extensions if e != extension]
def remove_extension(self, extension=None, *, package=None):
"""
Remove a registered extension.
Parameters
----------
extension : asdf.extension.AsdfExtension or asdf.extension.Extension or str, optional
An extension instance or URI pattern to remove.
package : str, optional
Remove only extensions provided by this package. If the ``extension``
argument is omitted, then all extensions from this package will
be removed.
"""
if extension is None and package is None:
raise ValueError("Must specify at least one of extension or package")
if extension is not None and not isinstance(extension, str):
extension = ExtensionProxy.maybe_wrap(extension)
def _remove_condition(e):
result = True
if isinstance(extension, str):
result = result and util.uri_match(extension, e.extension_uri)
elif isinstance(extension, ExtensionProxy):
result = result and e == extension
if package is not None:
result = result and e.package_name == package
return result
with self._lock:
self._extensions = [e for e in self.extensions if not _remove_condition(e)]
def reset_extensions(self):
"""
Reset extensions to the default list registered via entry points.
"""
with self._lock:
self._extensions = None
@property
def default_version(self):
"""
Get the default ASDF Standard version used for
new files.
Returns
-------
str
"""
return self._default_version
@default_version.setter
def default_version(self, value):
"""
Set the default ASDF Standard version used for
new files.
Parameters
----------
value : str
"""
self._default_version = validate_version(value)
@property
def io_block_size(self):
"""
Get the block size used when reading and writing
files.
Returns
-------
int
Block size, or -1 to use the filesystem's
preferred block size.
"""
return self._io_block_size
@io_block_size.setter
def io_block_size(self, value):
"""
Set the block size used when reading and writing
files.
Parameters
----------
value : int
Block size, or -1 to use the filesystem's
preferred block size.
"""
self._io_block_size = value
@property
def legacy_fill_schema_defaults(self):
"""
Get the configuration that controls filling defaults
from schemas for older ASDF Standard versions. If
`True`, missing default values will be filled from the
schema when reading files from ASDF Standard <= 1.5.0.
Later versions of the standard do not support removing
or filling schema defaults.
Returns
-------
bool
"""
return self._legacy_fill_schema_defaults
@legacy_fill_schema_defaults.setter
def legacy_fill_schema_defaults(self, value):
"""
Set the flag that controls filling defaults from
schemas for older ASDF Standard versions.
Parameters
----------
value : bool
"""
self._legacy_fill_schema_defaults = value
@property
def array_inline_threshold(self):
"""
Get the threshold below which arrays are automatically written
as inline YAML literals instead of binary blocks. This number
is compared to number of elements in the array.
Returns
-------
int or None
Integer threshold, or None to disable automatic selection
of the array storage type.
"""
return self._array_inline_threshold
@array_inline_threshold.setter
def array_inline_threshold(self, value):
"""
Set the threshold below which arrays are automatically written
as inline YAML literals instead of binary blocks. This number
is compared to number of elements in the array.
Parameters
----------
value : int or None
Integer threshold, or None to disable automatic selection
of the array storage type.
"""
self._array_inline_threshold = value
@property
def validate_on_read(self):
"""
Get configuration that controls schema validation of
ASDF files on read.
Returns
-------
bool
"""
return self._validate_on_read
@validate_on_read.setter
def validate_on_read(self, value):
"""
Set the configuration that controls schema validation of
ASDF files on read. If `True`, newly opened files will
be validated.
Parameters
----------
value : bool
"""
self._validate_on_read = value
def __repr__(self):
return (
"<AsdfConfig\n"
" array_inline_threshold: {}\n"
" default_version: {}\n"
" io_block_size: {}\n"
" legacy_fill_schema_defaults: {}\n"
" validate_on_read: {}\n"
">"
).format(
self.array_inline_threshold,
self.default_version,
self.io_block_size,
self.legacy_fill_schema_defaults,
self.validate_on_read,
)
class _ConfigLocal(threading.local):
def __init__(self):
self.config_stack = []
_global_config = AsdfConfig()
_local = _ConfigLocal()
def get_config():
"""
Get the current config, which may have been altered by
one or more surrounding calls to `asdf.config_context`.
Returns
-------
asdf.config.AsdfConfig
"""
if len(_local.config_stack) == 0:
return _global_config
else:
return _local.config_stack[-1]
@contextmanager
def config_context():
"""
Context manager that temporarily overrides asdf configuration.
The context yields an `asdf.config.AsdfConfig` instance that can be modified
without affecting code outside of the context.
"""
if len(_local.config_stack) == 0:
base_config = _global_config
else:
base_config = _local.config_stack[-1]
config = copy.copy(base_config)
_local.config_stack.append(config)
try:
yield config
finally:
_local.config_stack.pop()
|