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 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
|
import itertools
import re
import pint
from xarray import Coordinates, DataArray, Dataset, IndexVariable, Variable
from pint_xarray.compat import call_on_dataset
from pint_xarray.errors import format_error_message
from pint_xarray.index import PintIndex
no_unit_values = ("none", None)
unit_attribute_name = "units"
slice_attributes = ("start", "stop", "step")
temporary_name = "<this-array>"
time_units_re = r"\w+"
datetime_re = r"\d{4}-\d{2}-\d{2}(?:[ T]\d{2}:\d{2}:\d{2}(?:\.\d+)?)?"
datetime_units_re = re.compile(rf"{time_units_re} since {datetime_re}")
def is_datetime_unit(unit):
return isinstance(unit, str) and datetime_units_re.match(unit) is not None
def array_attach_units(data, unit):
"""attach a unit to the data
Parameters
----------
data : array-like
The data to attach units to.
unit : pint.Unit
The desired unit.
Returns
-------
quantity : pint.Quantity
"""
if unit in no_unit_values:
return data
if not isinstance(unit, pint.Unit):
raise ValueError(f"cannot use {unit!r} as a unit")
if isinstance(data, pint.Quantity):
if data.units == unit:
return data
raise ValueError(
f"Cannot attach unit {unit!r} to quantity: data "
f"already has units {data.units}"
)
registry = unit._REGISTRY
return registry.Quantity(data, unit)
def array_convert_units(data, unit):
"""convert the units of an array
This is roughly the same as ``data.to(unit)``.
Parameters
----------
data : quantity or array-like
The data to convert. If it is not a quantity, it is assumed to be
dimensionless.
unit : str or pint.Unit
The unit to convert to. If a string ``data`` has to be a quantity.
Returns
-------
result : pint.Quantity
The converted data
"""
if unit is None:
return data
if not isinstance(unit, (str, pint.Unit)):
raise ValueError(f"cannot use {unit!r} as a unit")
elif isinstance(unit, str) and not isinstance(data, pint.Quantity):
raise ValueError(f"cannot convert a non-quantity using {unit!r} as unit")
registry = data._REGISTRY if isinstance(unit, str) else unit._REGISTRY
if not isinstance(data, pint.Quantity):
data = registry.Quantity(data, "dimensionless")
return data.to(unit)
def array_extract_units(data):
"""extract the units of an array
If ``data`` is not a quantity, the units are ``None``
"""
try:
return data.units
except AttributeError:
return None
def array_strip_units(data):
"""strip the units of a quantity"""
try:
return data.magnitude
except AttributeError:
return data
def attach_units_variable(variable, units):
if isinstance(variable, IndexVariable):
new_obj = variable.copy()
if units is not None:
new_obj.attrs[unit_attribute_name] = units
elif isinstance(variable, Variable):
new_data = array_attach_units(variable.data, units)
new_obj = variable.copy(data=new_data)
else:
raise ValueError(f"invalid type: {variable!r}")
return new_obj
def dataset_from_variables(variables, coordinate_names, indexes, attrs):
data_vars = {
name: var for name, var in variables.items() if name not in coordinate_names
}
coords = {name: var for name, var in variables.items() if name in coordinate_names}
new_coords = Coordinates(coords, indexes=indexes)
return Dataset(data_vars=data_vars, coords=new_coords, attrs=attrs)
def attach_units_index(index, index_vars, units):
if all(unit is None for unit in units.values()):
# skip non-quantity indexed variables
return index
if isinstance(index, PintIndex) and index.units != units:
raise ValueError(
f"cannot attach units to quantified index: {index.units} != {units}"
)
return PintIndex(index=index, units=units)
def attach_units_dataset(obj, units):
attached = {}
rejected_vars = {}
indexed_variables = obj.xindexes.variables
for name, var in obj.variables.items():
if name in indexed_variables:
continue
unit = units.get(name)
try:
converted = attach_units_variable(var, unit)
attached[name] = converted
except ValueError as e:
rejected_vars[name] = (unit, e)
indexes, index_vars = obj.xindexes.copy_indexes()
for idx, idx_vars in obj.xindexes.group_by_index():
idx_units = {name: units.get(name) for name in idx_vars.keys()}
try:
attached_idx = attach_units_index(idx, idx_vars, idx_units)
indexes.update({k: attached_idx for k in idx_vars})
index_vars.update(attached_idx.create_variables(idx_vars))
except ValueError as e:
rejected_vars[name] = (units, e)
attached.update(index_vars)
if rejected_vars:
raise ValueError(rejected_vars)
reordered = {name: attached[name] for name in obj.variables.keys()}
return dataset_from_variables(reordered, obj._coord_names, indexes, obj.attrs)
def attach_units(obj, units):
if not isinstance(obj, (DataArray, Dataset)):
raise ValueError(f"cannot attach units to {obj!r}: unknown type")
if isinstance(obj, DataArray):
units = units.copy()
if obj.name in units:
units[temporary_name] = units.get(obj.name)
try:
new_obj = call_on_dataset(
attach_units_dataset, obj, name=temporary_name, units=units
)
except ValueError as e:
(rejected_vars,) = e.args
if temporary_name in rejected_vars:
rejected_vars[obj.name] = rejected_vars.pop(temporary_name)
raise ValueError(format_error_message(rejected_vars, "attach")) from e
return new_obj
def attach_unit_attributes(obj, units, attr="units"):
new_obj = obj.copy()
if isinstance(obj, DataArray):
for name, var in itertools.chain([(obj.name, new_obj)], new_obj.coords.items()):
unit = units.get(name)
if unit is None:
continue
var.attrs[attr] = unit
elif isinstance(obj, Dataset):
for name, var in new_obj.variables.items():
unit = units.get(name)
if unit is None:
continue
var.attrs[attr] = unit
else:
raise ValueError(f"cannot attach unit attributes to {obj!r}: unknown type")
return new_obj
def convert_units_variable(variable, units):
if isinstance(variable, IndexVariable):
if variable.level_names:
# don't try to convert MultiIndexes
return variable
if units is not None:
quantity = array_attach_units(
variable.data, variable.attrs.get(unit_attribute_name)
)
converted = array_convert_units(quantity, units)
new_obj = variable.copy(data=array_strip_units(converted))
new_obj.attrs[unit_attribute_name] = array_extract_units(converted)
else:
new_obj = variable
elif isinstance(variable, Variable):
converted = array_convert_units(variable.data, units)
new_obj = variable.copy(data=converted)
else:
raise ValueError(f"unknown type: {variable}")
return new_obj
def convert_units_index(index, index_vars, units):
if not isinstance(index, PintIndex):
raise ValueError("cannot convert non-quantified index")
converted_vars = {}
failed = {}
for name, var in index_vars.items():
unit = units.get(name)
try:
converted = convert_units_variable(var, unit)
converted_vars[name] = strip_units_variable(converted)
except (ValueError, pint.errors.PintTypeError) as e:
failed[name] = e
if failed:
# raise exception group
raise ValueError("failed to convert index variables:", failed)
# TODO: figure out how to pull out `options`
converted_index = index.index.from_variables(converted_vars, options={})
return PintIndex(index=converted_index, units=units)
def convert_units_dataset(obj, units):
converted = {}
failed = {}
indexed_variables = obj.xindexes.variables
for name, var in obj.variables.items():
if name in indexed_variables:
continue
unit = units.get(name)
try:
converted[name] = convert_units_variable(var, unit)
except (ValueError, pint.errors.PintTypeError) as e:
failed[name] = e
indexes, index_vars = obj.xindexes.copy_indexes()
for idx, idx_vars in obj.xindexes.group_by_index():
idx_units = {name: units.get(name) for name in idx_vars.keys()}
if all(unit is None for unit in idx_units.values()):
continue
try:
converted_index = convert_units_index(idx, idx_vars, idx_units)
indexes.update({k: converted_index for k in idx_vars})
index_vars.update(converted_index.create_variables())
except (ValueError, pint.errors.PintTypeError) as e:
names = tuple(idx_vars)
failed[names] = e
converted.update(index_vars)
if failed:
raise ValueError(failed)
reordered = {name: converted[name] for name in obj.variables.keys()}
return dataset_from_variables(reordered, obj._coord_names, indexes, obj.attrs)
def convert_units(obj, units):
if not isinstance(obj, (DataArray, Dataset)):
raise ValueError(f"cannot convert object: {obj!r}: unknown type")
if isinstance(obj, DataArray):
units = units.copy()
if obj.name in units:
units[temporary_name] = units.pop(obj.name)
try:
new_obj = call_on_dataset(
convert_units_dataset, obj, name=temporary_name, units=units
)
except ValueError as e:
(failed,) = e.args
if temporary_name in failed:
failed[obj.name] = failed.pop(temporary_name)
raise ValueError(format_error_message(failed, "convert")) from e
return new_obj
def extract_units_dataset(obj):
return {name: array_extract_units(var.data) for name, var in obj.variables.items()}
def extract_units(obj):
if not isinstance(obj, (DataArray, Dataset)):
raise ValueError(f"unknown type: {type(obj)}")
unit_attributes = extract_unit_attributes(obj)
units = call_on_dataset(extract_units_dataset, obj, name=temporary_name)
if temporary_name in units:
units[obj.name] = units.pop(temporary_name)
units_ = unit_attributes.copy()
units_.update({k: v for k, v in units.items() if v is not None})
return units_
def extract_unit_attributes_dataset(obj, attr="units"):
all_units = {name: var.attrs.get(attr, None) for name, var in obj.variables.items()}
return {
name: unit for name, unit in all_units.items() if not is_datetime_unit(unit)
}
def extract_unit_attributes(obj, attr="units"):
if not isinstance(obj, (DataArray, Dataset)):
raise ValueError(
f"cannot retrieve unit attributes from unknown type: {type(obj)}"
)
units = call_on_dataset(
extract_unit_attributes_dataset, obj, name=temporary_name, attr=attr
)
if temporary_name in units:
units[obj.name] = units.pop(temporary_name)
return units
def strip_units_variable(var):
if not isinstance(var.data, pint.Quantity):
return var
data = array_strip_units(var.data)
return var.copy(data=data)
def strip_units_dataset(obj):
variables = {name: strip_units_variable(var) for name, var in obj.variables.items()}
indexes = {
name: (index.index if isinstance(index, PintIndex) else index)
for name, index in obj.xindexes.items()
}
return dataset_from_variables(variables, obj._coord_names, indexes, obj.attrs)
def strip_units(obj):
if not isinstance(obj, (DataArray, Dataset)):
raise ValueError("cannot strip units from {obj!r}: unknown type")
return call_on_dataset(strip_units_dataset, obj, name=temporary_name)
def strip_unit_attributes_dataset(obj, attr="units"):
new_obj = obj.copy()
for var in new_obj.variables.values():
if is_datetime_unit(var.attrs.get(attr, "")):
continue
var.attrs.pop(attr, None)
return new_obj
def strip_unit_attributes(obj, attr="units"):
if not isinstance(obj, (DataArray, Dataset)):
raise ValueError(f"cannot strip unit attributes from unknown type: {type(obj)}")
return call_on_dataset(
strip_unit_attributes_dataset, obj, name=temporary_name, attr=attr
)
def slice_extract_units(indexer):
elements = {name: getattr(indexer, name) for name in slice_attributes}
extracted_units = [
array_extract_units(value)
for name, value in elements.items()
if value is not None
]
none_values = [_ is None for _ in extracted_units]
if not extracted_units or all(none_values):
# empty slice (slice(None)) or slice without units
return None
dimensionalities = {
str(getattr(units, "dimensionality", "dimensionless"))
for units in extracted_units
}
if len(dimensionalities) > 1:
raise ValueError(f"incompatible units in {indexer}: {dimensionalities}")
units = [_ for _ in extracted_units if _ is not None]
if len(set(units)) == 1:
return units[0]
else:
units_ = units[0]
registry = units_._REGISTRY
return registry.Quantity(1, units_).to_base_units().units
def convert_units_slice(indexer, units):
attrs = {name: getattr(indexer, name) for name in slice_attributes}
converted = {
name: array_convert_units(value, units) if value is not None else None
for name, value in attrs.items()
}
args = [converted[name] for name in slice_attributes]
return slice(*args)
def convert_indexer_units(indexers, units):
def convert(indexer, units):
if isinstance(indexer, slice):
return convert_units_slice(indexer, units)
elif isinstance(indexer, DataArray):
return convert_units(indexer, {None: units})
elif isinstance(indexer, Variable):
return convert_units_variable(indexer, units)
else:
return array_convert_units(indexer, units)
converted = {}
invalid = {}
for name, indexer in indexers.items():
indexer_units = units.get(name)
try:
converted[name] = convert(indexer, indexer_units)
except (ValueError, pint.errors.PintTypeError) as e:
invalid[name] = e
if invalid:
raise ValueError(format_error_message(invalid, "convert_indexers"))
return converted
def extract_indexer_units(indexers):
def extract(indexer):
if isinstance(indexer, slice):
return slice_extract_units(indexer)
elif isinstance(indexer, (DataArray, Variable)):
return array_extract_units(indexer.data)
else:
return array_extract_units(indexer)
return {name: extract(indexer) for name, indexer in indexers.items()}
def strip_indexer_units(indexers):
def strip(indexer):
if isinstance(indexer, slice):
return slice(
array_strip_units(indexer.start),
array_strip_units(indexer.stop),
array_strip_units(indexer.step),
)
elif isinstance(indexer, DataArray):
return strip_units(indexer)
elif isinstance(indexer, Variable):
return strip_units_variable(indexer)
else:
return array_strip_units(indexer)
return {name: strip(indexer) for name, indexer in indexers.items()}
|