| 1 |
import asdf |
| 2 |
import numpy as np |
| 3 |
import pytest |
| 4 |
from asdf.testing import helpers |
| 5 |
from astropy import units |
| 6 |
from astropy.units import Quantity |
| 7 |
from numpy.testing import assert_array_equal |
| 8 |
|
| 9 |
from asdf_astropy.tests.versions import ASTROPY_GE_7_1 |
| 10 |
|
| 11 |
|
| 12 |
def create_quantities(): |
| 13 |
return [ |
| 14 |
# Scalar: |
| 15 |
Quantity(2.71828, units.kpc), |
| 16 |
# Non-float scalar: |
| 17 |
Quantity(7, units.K, dtype=np.int32), |
| 18 |
# Single element array: |
| 19 |
Quantity([3.14159], units.kg), |
| 20 |
# Multiple element array: |
| 21 |
Quantity([x * 2.3081 for x in range(10)], units.ampere), |
| 22 |
# Multiple dimension array: |
| 23 |
Quantity(np.arange(100, dtype=np.float64).reshape(5, 20), units.km), |
| 24 |
# Non-float array: |
| 25 |
Quantity(np.zeros((5, 5), dtype=np.uint16), units.cm, dtype=np.uint16), |
| 26 |
] |
| 27 |
|
| 28 |
|
| 29 |
@pytest.mark.parametrize("quantity", create_quantities()) |
| 30 |
def test_serialization(quantity, tmp_path): |
| 31 |
file_path = tmp_path / "test.asdf" |
| 32 |
with asdf.AsdfFile() as af: |
| 33 |
af["quantity"] = quantity |
| 34 |
af.write_to(file_path) |
| 35 |
|
| 36 |
with asdf.open(file_path) as af: |
| 37 |
assert (af["quantity"].value == quantity.value).all() |
| 38 |
assert af["quantity"].dtype == quantity.dtype |
| 39 |
assert (af["quantity"] == quantity).all() |
| 40 |
|
| 41 |
|
| 42 |
def test_read_untagged_unit(): |
| 43 |
value = 2.71828 |
| 44 |
yaml = f""" |
| 45 |
quantity: !unit/quantity-1.1.0 |
| 46 |
value: {value} |
| 47 |
unit: kpc |
| 48 |
""" |
| 49 |
buff = helpers.yaml_to_asdf(yaml, version="1.5.0") |
| 50 |
with asdf.open(buff) as af: |
| 51 |
assert af["quantity"].value == value |
| 52 |
assert af["quantity"].unit.is_equivalent(units.kpc) |
| 53 |
|
| 54 |
|
| 55 |
def test_read_tagged_unit(): |
| 56 |
value = 2.71828 |
| 57 |
yaml = f""" |
| 58 |
quantity: !unit/quantity-1.1.0 |
| 59 |
value: {value} |
| 60 |
unit: !unit/unit-1.0.0 kpc |
| 61 |
""" |
| 62 |
buff = helpers.yaml_to_asdf(yaml, version="1.5.0") |
| 63 |
with asdf.open(buff) as af: |
| 64 |
assert af["quantity"].value == value |
| 65 |
assert af["quantity"].unit.is_equivalent(units.kpc) |
| 66 |
|
| 67 |
|
| 68 |
def test_read_array_value(): |
| 69 |
yaml = """ |
| 70 |
quantity: !unit/quantity-1.1.0 |
| 71 |
value: !core/ndarray-1.0.0 [1.0, 2.0, 3.0, 4.0] |
| 72 |
unit: km |
| 73 |
""" |
| 74 |
buff = helpers.yaml_to_asdf(yaml, version="1.5.0") |
| 75 |
with asdf.open(buff) as af: |
| 76 |
assert_array_equal(af["quantity"].value, np.array([1.0, 2.0, 3.0, 4.0])) |
| 77 |
assert af["quantity"].unit.is_equivalent(units.km) |
| 78 |
|
| 79 |
|
| 80 |
def test_memmap(tmp_path): |
| 81 |
""" |
| 82 |
Test that memmap (memmap=True) works with quantities. |
| 83 |
|
| 84 |
Unfortunately, this is not a simple `isinstance(obj, np.memmap)` |
| 85 |
Instead it requires a more complicated check. |
| 86 |
""" |
| 87 |
file_path = tmp_path / "test.asdf" |
| 88 |
quantity = Quantity(np.arange(100, dtype=np.float64).reshape(5, 20), units.km) |
| 89 |
|
| 90 |
new_value = 42.14 * units.cm |
| 91 |
new_quantity = quantity.copy() |
| 92 |
new_quantity[-1, -1] = new_value |
| 93 |
|
| 94 |
# Write initial ASDF file |
| 95 |
with asdf.AsdfFile() as af: |
| 96 |
af.tree = {"quantity": quantity} |
| 97 |
af.write_to(file_path) |
| 98 |
|
| 99 |
# Update a value in the ASDF file |
| 100 |
with asdf.open(file_path, mode="rw", memmap=True) as af: |
| 101 |
assert (af.tree["quantity"] == quantity).all() |
| 102 |
assert af.tree["quantity"][-1, -1] != new_value |
| 103 |
|
| 104 |
af.tree["quantity"][-1, -1] = new_value |
| 105 |
|
| 106 |
assert af.tree["quantity"][-1, -1] == new_value |
| 107 |
assert (af.tree["quantity"] != quantity).any() |
| 108 |
assert (af.tree["quantity"] == new_quantity).all() |
| 109 |
|
| 110 |
with asdf.open(file_path, mode="rw", memmap=True) as af: |
| 111 |
assert af.tree["quantity"][-1, -1] == new_value |
| 112 |
assert (af.tree["quantity"] != quantity).any() |
| 113 |
assert (af.tree["quantity"] == new_quantity).all() |
| 114 |
|
| 115 |
|
| 116 |
def test_no_memmap(tmp_path): |
| 117 |
""" |
| 118 |
Test that turning off memmap (memmap=False) works as expected for quantities |
| 119 |
""" |
| 120 |
file_path = tmp_path / "test.asdf" |
| 121 |
quantity = Quantity(np.arange(100, dtype=np.float64).reshape(5, 20), units.km) |
| 122 |
|
| 123 |
new_value = 42.14 * units.cm |
| 124 |
new_quantity = quantity.copy() |
| 125 |
new_quantity[-1, -1] = new_value |
| 126 |
|
| 127 |
# Write initial ASDF file |
| 128 |
with asdf.AsdfFile() as af: |
| 129 |
af.tree = {"quantity": quantity} |
| 130 |
af.write_to(file_path) |
| 131 |
|
| 132 |
# Update a value in the ASDF file |
| 133 |
with asdf.open(file_path, mode="rw", memmap=False) as af: |
| 134 |
assert (af.tree["quantity"] == quantity).all() |
| 135 |
assert af.tree["quantity"][-1, -1] != new_value |
| 136 |
|
| 137 |
af.tree["quantity"][-1, -1] = new_value |
| 138 |
|
| 139 |
assert af.tree["quantity"][-1, -1] == new_value |
| 140 |
assert (af.tree["quantity"] != quantity).any() |
| 141 |
assert (af.tree["quantity"] == new_quantity).all() |
| 142 |
|
| 143 |
with asdf.open(file_path, mode="rw", memmap=False) as af: |
| 144 |
assert af.tree["quantity"][-1, -1] != new_value |
| 145 |
assert (af.tree["quantity"] != new_quantity).any() |
| 146 |
assert (af.tree["quantity"] == quantity).all() |
| 147 |
|
| 148 |
|
| 149 |
@pytest.mark.skipif(ASTROPY_GE_7_1, reason=r"MaskedQuantity support was added in astropy 7.1") |
| 150 |
def test_masked_quantity_raises(): |
| 151 |
yaml = """ |
| 152 |
quantity: !unit/quantity-1.1.0 |
| 153 |
unit: !unit/unit-1.0.0 Ymol |
| 154 |
value: !core/ndarray-1.0.0 |
| 155 |
data: [1.0, 2.0, null] |
| 156 |
mask: !core/ndarray-1.0.0 |
| 157 |
data: [false, false, true] |
| 158 |
datatype: bool8 |
| 159 |
shape: [3] |
| 160 |
datatype: float64 |
| 161 |
shape: [3] |
| 162 |
""" |
| 163 |
buff = helpers.yaml_to_asdf(yaml, version="1.5.0") |
| 164 |
with pytest.raises(NotImplementedError, match=r"MaskedQuantity support requires astropy 7.1 or later"): |
| 165 |
asdf.open(buff) |