Releases | Open Source Science

What's Changed

use updated terminology for standard by @braingram in https://github.com/asdf-format/asdf/pull/1953
warn when bundled pytest plugin runs by @braingram in https://github.com/asdf-format/asdf/pull/1959
fix bug in assumption about what is tagged by @braingram in https://github.com/asdf-format/asdf/pull/1960
add note discouraging metaschemas by @braingram in https://github.com/asdf-format/asdf/pull/1964

Full Changelog: https://github.com/asdf-format/asdf/compare/4.4.0...4.5.0

- Python
Published by braingram 6 months ago

What's Changed

asdftool fixes by @braingram in https://github.com/asdf-format/asdf/pull/1939
Port benchmarks to pytest-benchmark, enable codspeed by @braingram in https://github.com/asdf-format/asdf/pull/1943
add asdftool validate by @braingram in https://github.com/asdf-format/asdf/pull/1952
Bump actions/checkout from 4 to 5 by @dependabot[bot] in https://github.com/asdf-format/asdf/pull/1954
Simplify open by @braingram in https://github.com/asdf-format/asdf/pull/1955
Check for external pytest-asdf-plugin and don't register bundled plugin if the external one exists by @braingram in https://github.com/asdf-format/asdf/pull/1957
update changelog for 4.4.0 by @braingram in https://github.com/asdf-format/asdf/pull/1958

Full Changelog: https://github.com/asdf-format/asdf/compare/4.3.0...4.4.0

- Python
Published by braingram 6 months ago

What's Changed

return ndarray if lazy_load=False by @braingram in https://github.com/asdf-format/asdf/pull/1929
Add dump load dumps and loads to top level asdf by @braingram in https://github.com/asdf-format/asdf/pull/1930
Bump OpenAstronomy/github-actions-workflows from 1 to 2 by @dependabot[bot] in https://github.com/asdf-format/asdf/pull/1933
Docs updates by @braingram in https://github.com/asdf-format/asdf/pull/1938
Fix urljoin usage for python 3.14 by @braingram in https://github.com/asdf-format/asdf/pull/1932
deprecate resolver argument to load_schema by @braingram in https://github.com/asdf-format/asdf/pull/1934
deprecate refreshextensionmanager by @braingram in https://github.com/asdf-format/asdf/pull/1935
Restrict scope of ndarray validators by @braingram in https://github.com/asdf-format/asdf/pull/1937
Fixes for custom schemas by @braingram in https://github.com/asdf-format/asdf/pull/1931
deprecate urlmapping argument to getvalidator by @braingram in https://github.com/asdf-format/asdf/pull/1936
generate changelog for 4.3.0 by @braingram in https://github.com/asdf-format/asdf/pull/1942

Full Changelog: https://github.com/asdf-format/asdf/compare/4.2.0...4.3.0

- Python
Published by braingram 7 months ago

What's Changed

fix downstream astrocut tests by @braingram in https://github.com/asdf-format/asdf/pull/1905
Use fsspec for all non-local urls by @braingram in https://github.com/asdf-format/asdf/pull/1906
allow extra keywords in structured datatype validation by @braingram in https://github.com/asdf-format/asdf/pull/1901
use yaml constructors for _IgnoreCustomTagsLoader by @braingram in https://github.com/asdf-format/asdf/pull/1907
Datatype validator fix by @braingram in https://github.com/asdf-format/asdf/pull/1904
fix astrocut downstream tests by @braingram in https://github.com/asdf-format/asdf/pull/1912
add weldx downstream by @braingram in https://github.com/asdf-format/asdf/pull/1919
update pyproject.toml to avoid setuptools warnings by @braingram in https://github.com/asdf-format/asdf/pull/1917
allow non-null post tree pre block padding by @braingram in https://github.com/asdf-format/asdf/pull/1918
allow block index loading to use CSafeLoader by @braingram in https://github.com/asdf-format/asdf/pull/1920
Cleanup docs by @braingram in https://github.com/asdf-format/asdf/pull/1913
provide usedforsecurity to hashlib for block md5 by @braingram in https://github.com/asdf-format/asdf/pull/1925
fix deepcopy of lazy tree by @braingram in https://github.com/asdf-format/asdf/pull/1922
update changelog for 4.2.0 release by @braingram in https://github.com/asdf-format/asdf/pull/1926

Full Changelog: https://github.com/asdf-format/asdf/compare/4.1.0...4.2.0

- Python
Published by braingram 9 months ago

What's Changed

update downstream jobs to run on python 3.12 by @braingram in https://github.com/asdf-format/asdf/pull/1876
fix type and filter docs for search by @braingram in https://github.com/asdf-format/asdf/pull/1880
cleanup downstream by @braingram in https://github.com/asdf-format/asdf/pull/1885
improve schema info collection combiner handling by @braingram in https://github.com/asdf-format/asdf/pull/1875
pyproject.toml: versionfile requires setuptoolsscm>=8 by @wdconinc in https://github.com/asdf-format/asdf/pull/1894
Add Converter.to_info to customize info and search by @braingram in https://github.com/asdf-format/asdf/pull/1884
fix dkist downstream test by @braingram in https://github.com/asdf-format/asdf/pull/1896
docs/theme-updates by @alphasentaurii in https://github.com/asdf-format/asdf/pull/1897
prep 4.1.0 release notes by @braingram in https://github.com/asdf-format/asdf/pull/1898

New Contributors

@wdconinc made their first contribution in https://github.com/asdf-format/asdf/pull/1894
@alphasentaurii made their first contribution in https://github.com/asdf-format/asdf/pull/1897

Full Changelog: https://github.com/asdf-format/asdf/compare/4.0.0...4.1.0

- Python
Published by braingram about 1 year ago

asdf - 4.0.0

This is a major release for asdf that includes removal of deprecated features and changes to some defaults.

Please see the "what's new" documentation: https://asdf.readthedocs.io/en/4.0.0/asdf/whats_new.html#whats-new-4-0-0 for a description of the included changes.

Changes include:

Feature

Switch default ASDF standard to 1.6.0. (#1744 <https://github.com/asdf-format/asdf/pull/1744>_)
Raise RuntimeError if a Convert subclass supports multiple tags but doesn't implement selecttag. (#1853 <https://github.com/asdf-format/asdf/pull/1853>)

General

Set memmap=False to default for asdf.open and AsdfFile.__init__. (#1801 <https://github.com/asdf-format/asdf/pull/1801>_)

Removal

remove copy_arrays (replaced by memmap) (#1800 <https://github.com/asdf-format/asdf/pull/1800>_)
Remove deprecated API. See docs for full details. (#1852 <https://github.com/asdf-format/asdf/pull/1852>_)
Switch default convertunknownndarraysubclasses to False and issue deprecation warning if it is enabled. (#1858 <https://github.com/asdf-format/asdf/pull/1858>)

- Python
Published by braingram over 1 year ago

Bugfix

Allow asdf.util.load_yaml to handle recursive objects (#1825 <https://github.com/asdf-format/asdf/pull/1825>_)

Doc

added issue links to changelog entries #1827
Change asdf standard changelog entries to notes to ease transition to towncrier #1830

General

fix changelog checker to remove brackets #1828

Removal

Deprecate ignore_version_mismatch. This option has done nothing since asdf 3.0.0 and will be removed in an upcoming asdf version #1819

- Python
Published by braingram over 1 year ago

asdf - 3.4.0

Fix issue where roundtripping a masked array with no masked values removes the mask [#1803]
Use a custom exception AsdfSerializationError to indicate when an object in the tree fails to be serialized by asdf (and by yaml). This exception currently inherits from yaml.representer.RepresenterError to provide backwards compatibility. However this inheritance may be dropped in a future asdf version. Please migrate to the new AsdfSerializationError. [#1809]
Drop importlib_metadata as a dependency on Python 3.12 and newer [#1810]
Bumped minimal requirement on attrs from 20.1.0 to 22.2.0 [#1815]

- Python
Published by braingram over 1 year ago

asdf - 3.3.0

Fix __asdf_traverse__ for non-tagged objects [#1739]
Deprecate asdf.testing.helpers.format_tag [#1774]
Deprecate asdf.versioning.AsdfSpec [#1774]
Deprecate asdf.util.filepath_to_url use pathlib.Path.to_uri [#1735]
Record package providing manifest for extensions used to write a file and AsdfPackageVersionWarning when installed extension/manifest package does not match that used to write the file [#1758]
Fix bug where a dictionary containing a key id caused any contained references to fail to resolve [#1716]
Issue a AsdfManifestURIMismatchWarning during write if a used extension was created from a manifest registered with a uri that does not match the id in the manifest [#1785]
Allow converters to provide types as strings that can resolve to public classes (even if the class is implemented in a private module). [#1654]
Add options to control saving the base array when saving array views controlled via AsdfConfig.default_array_save_base, AsdfFile.set_array_save_base and SerializationContext.set_array_save_base [#1753]
Deprecate ignore_implicit_conversion and "implicit conversion" [#1724]
Add lazy_tree option to asdf.open and asdf.config to allow lazy deserialization of ASDF tagged tree nodes to custom objects. [#1733]

- Python
Published by braingram over 1 year ago

asdf - 3.2.0

Deprecate AsdfFile.version_map [#1745]
Fix numpy.ma.MaskedArray saving for numpy 2.x [#1769]
Add float16 support [#1692]
Removed unused asdf-unit-schemas dependency [#1767]

- Python
Published by braingram almost 2 years ago

3.1.0 (2024-02-27)

The ASDF Standard is at v1.6.0 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Cleanup asdf.util including deprecating: human_list resolve_name minversion and iter_subclasses [#1688]
Deprecate validation on AsdfFile.tree assignment. Please use AsdfFile.validate to validate the tree [#1691]
Deprecate validation during AsdfFile.resolve_references. Please use AsdfFile.validate to validate the tree [#1691]
Deprecate asdf.asdf and AsdfFile.resolve_and_inline [#1690]
Deprecate automatic calling of AsdfFile.find_references during AsdfFile.__init__ and asdf.open [#1708]
Allow views of memmapped arrays to keep the backing mmap open to avoid segfaults [#1668]
Introduce memmap argument to asdf.open that overrides copy_arrays with documentation that describes that the default for memmap when copy_arrays is removed in an upcoming asdf release will be False and asdf will no longer by-default memory map arrays. [#1667]
Introduce asdf.util.load_yaml to load just the YAML contents of an ASDF file (with the option tagged to load the contents as a tree of asdf.tagged.Tagged instances to preserve tags) [#1700]
Require pytest 7+ and update asdf pytest plugin to be compatible with the current development version of pytest (8.1) [#1731]
Eliminate the use of the legacy tmpdir fixture in favor of the new tmp_path fixture for temporary directory creation. [#1759]
Remove conversion of warnings to errors in asdf pytest plugin. This prevented other warning filters (like those provided with -W) from working. If you want these warnings to produce errors you can now add your own warning filter [#1757]
Only show str representation during info and search if it contains a single line (and does not fail) [#1748]

- Python
Published by braingram almost 2 years ago

asdf - 3.0.1

The ASDF Standard is at v1.6.0 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Fix bug in asdftool diff for arrays within a list [#1672]

- Python
Published by braingram over 2 years ago

asdf - 3.0.0

Asdf 3.0.0 is the first major asdf release since 2018.

Thank you to all the contributors!

There are many large and small changes in asdf 3.0.

Please see the updated docs and the What's New page for more details.

The ASDF Standard is at v1.6.0 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Drop support for ASDF-in-FITS. [#1288]
Add all_array_storage, all_array_compression and all_array_compression_kwargs to asdf.config.AsdfConfig [#1468]
Move built-in tags to converters (except ndarray and integer). [#1474]
Add block storage support to Converter [#1508]
Remove deprecated legacy extension API [#1464]
Fix issue opening files that don't support fileno [#1557]
Allow Converters to defer conversion to other Converters by returning None in Converter.select_tag [#1561]
Remove deprecated tests.helpers [#1597]
Remove deprecated loadcustomschema [#1596]
Remove deprecated TagDefinition.schema_uri [#1595]
Removed deprecated AsdfFile.open and deprecated asdf.open AsdfFile.write_to and AsdfFile.update kwargs [#1592]
Fix AsdfFile.info loading all array data [#1572]
Blank out AsdfFile.tree on close [#1575]
Move ndarray to a converter, add convert_unknown_ndarray_subclasses to asdf.config.AsdfConfig, move asdf.Stream to asdf.tags.core.Stream, update block storage support for Converter and update internal block API [#1537]
Remove deprecated resolvelocalrefs argument to load_schema [#1623]
Move IntegerType to converter and drop cache of converted values. [#1527]
Remove legacy extension API [#1637]
Fix bug that left out the name of the arrays that differed for asdftool diff comparisons [#1652]

- Python
Published by braingram over 2 years ago

asdf - 2.15.2

The ASDF Standard is at v1.6.0

Add support for python 3.12 [#1641]

- Python
Published by braingram over 2 years ago

asdf - 2.15.1

The ASDF Standard is at v1.6.0

Drop Python 3.8 support [#1556]
Drop NumPy 1.20, 1.21 support [#1568]
Convert numpy scalars to python types during yaml encoding to handle NEP51 changes for numpy 2.0 [#1605]
Vendorize jsonschema 4.17.3 [#1591]

jsonschema vendorization

Asdf 2.15.1 includes internally a version of jsonschema 4.17.3. This inclusion was done to deal with incompatible changes in jsonschema 4.18.

Many libraries that use asdf import jsonschema to allow catching of ValidationError instances that might be raised during schema validation. Prior to asdf 2.15 this error type was not part of the public asdf API. For 2.15 and later users are expected to import ValidationError from asdf.exceptions (instead of jsonschema directly).

To further ease the transition, asdf will, when possible, use exceptions imported from any installed version of jsonschema. This means that when the asdf internal jsonschema raises a ValidationError on a system where jsonschema was separately installed, the internal jsonschema will attempt to use ValidationError from the installed version. This should allow code that catches exceptions imported from jsonschema to continue to work with no changes. However, asdf cannot guarantee compatibility with future installed jsonschema versions and users are encouraged to update their code to import ValidationError from asdf.exceptions.

Finally, asdf is temporarily keeping jsonschema as a dependency as many libraries expected this to be installed by asdf. We expect to drop this requirement soon (likely in 3.0.0) and this change might occur in a minor or even patch version.

The above text is also available in the updated docs under What's New.

Full Changelog: https://github.com/asdf-format/asdf/compare/2.15.0...2.15.1

- Python
Published by braingram over 2 years ago

asdf -

The ASDF Standard is at v1.6.0

Require numpy<1.25 for python 3.8 [#1327]
Add AsdfProvisionalAPIWarning to warn developers of new features that may undergo breaking changes but are likely to be included as stable features (without this warning) in a future version of ASDF [#1295]
Add AsdfDeprecationWarning to AsdfFile.blocks [#1336]
Document policy for ASDF release cycle including when support for ASDF versions end. Also document dependency support policy. [#1323]
Update lower pins on numpy (per release policy), packaging, and pyyaml to ones that we can successfully build and test against. [#1360]
Provide more informative filename when failing to open a file [#1357]
Add new plugin type for custom schema validators. [#1328]
Add AsdfDeprecationWarning to asdf.types.CustomType [#1359]
Throw more useful error when provided with a path containing an extra leading slash [#1356]
Add AsdfDeprecationWarning to AsdfInFits. Support for reading and writing ASDF in fits files is being moved to stdatamodels. [#1337]
Add AsdfDeprecationWarning to asdf.resolver [#1362]
Add AsdfDeprecationWarning to asdf.tests.helpers.assertextensioncorrectness [#1388]
Add AsdfDeprecationWarning to asdf.type_index [#1403]
Add warning to use of asdftool extract and remove-hdu about deprecation and impending removal [#1411]
Deprecate AsdfFile attributes that use the legacy extension api [#1417]
Add AsdfDeprecationWarning to asdf.types [#1401]
deprecate defaultextensions, getdefaultresolver and getcachedasdfextension_list in asdf.extension [#1409]
move asdf.types.formattag to asdf.testing.helpers.formattag [#1433]
Deprecate AsdfExtenion, AsdfExtensionList, BuiltinExtension [#1429]
Add AsdfDeprecationWarning to asdf_extensions entry point [#1361]
Deprecate asdf.tests.helpers [#1440]
respect umask when determining file permissions for written files [#1451]
rename master branch to main [#1479]

- Python
Published by braingram almost 3 years ago

asdf - 2.14.4

Changes include:

require jsonschema<4.18 [#1487]

- Python
Published by WilliamJamieson almost 3 years ago

asdf - 2.14.3

Changes include:

Use importlib_metadata for all python versions [#1260]
Fix issue #1268, where update could fail to clear memmaps for some files [#1269]
Bump asdf-transform-schemas version [#1278]

- Python
Published by WilliamJamieson about 3 years ago

asdf - 2.14.2

Changes include:

Fix issue #1256, where enum could not be used on tagged objects. [#1257]

- Python
Published by WilliamJamieson about 3 years ago

asdf - 2.14.1

Changes Include:

Fix issue #1239, close memmap with asdf file context [#1241]

- Python
Published by braingram over 3 years ago

asdf - 2.14.0

Changes include: - Update citation. [#1184] - Add search support to ~asdf.AsdfFile.schema_info. [#1187] - Add asdf.search.AsdfSearchResult support for ~asdf.AsdfFile.schema_info and ~asdf.search.AsdfSearchResult.schema_info method. [#1197] - Use forc ndarray flag to correctly test for fortran array contiguity [#1206] - Unpin jsonschema version and fix jsonschema deprecation warnings. [#1185] - Replace pkg_resources with importlib.metadata. [#1199] - Fix default validation for jsonschema 4.10+ [#1203] - Add asdf-unit-schemas as a dependency, for backwards compatibility. [#1210] - Remove stray toplevel packages docker docs and compatibility_tests from wheel [#1214] - Close files opened during a failed call to asdf.open [#1221] - Modify generic_file for fsspec compatibility [#1226] - Add fsspec http filesystem support [#1228] - Memmap whole file instead of each array [#1230] - Fix issue #1232 where array data was duplicated during resaving of a fits file [#1234]

- Python
Published by braingram over 3 years ago

asdf - 2.13.0

Changes include:

Add ability to pull information from schema about asdf file data, using schema_info method.

- Python
Published by WilliamJamieson over 3 years ago

asdf - 2.12.1

Changes include:

Overhaul of the ASDF documentation to make it more consistent and readable.
Update deprecated instances of abstractproperty to abstractmethod
Move build configuration into pyproject.toml
Pin jsonschema to below 4.10.0.

- Python
Published by WilliamJamieson over 3 years ago

asdf - 2.11.2

Changes include:

Backport jsonschema pin to strictly less than 4.10.1.

- Python
Published by WilliamJamieson over 3 years ago

asdf - 2.12.0

Changes include:

Added ability to display title as a comment in using the info() functionality.
Add ability to set asdf-standard version for schema example items.

- Python
Published by WilliamJamieson over 3 years ago

asdf - 2.11.1

Changes include:

Update minimum astropy version to 5.0.4.

- Python
Published by WilliamJamieson almost 4 years ago

asdf - 2.11.0

Changes include: - Update minimum jsonschema version to 4.0.1.

- Python
Published by WilliamJamieson almost 4 years ago

asdf - 2.10.1

Changes include: - Bugfix for circular build dependency for asdf. - Fix small bug with handling multiple schema uris per tag.

- Python
Published by WilliamJamieson almost 4 years ago

asdf - 2.10.0

Changes include:

Replace asdf-standard submodule with pypi package. [#1079]

- Python
Published by WilliamJamieson about 4 years ago

asdf - 2.9.2

Changes include:

Fix deprecation warnings stemming from the release of pytest 7.0.0.
Fix bug in pytest plugin when schemas are not in a directory named "schemas".

- Python
Published by WilliamJamieson about 4 years ago