fix: migrate by default

[gadomski]

Related Issue(s):

• Closes Migrate by default #1504
• Motivated by Version 1.12.0 breaks ProjectionExtension.crs_string for items using projection extension <2 #1503

Description:

With increased heterogeneity of extensions in the ecosystem, especially breaking changes like proj v2, there's more and more schema allowed in a valid STAC value. Handling these in pystac is ... tricky.

On read+load, pystac has the concept of "migration", where fields on STAC objects and in STAC extensions are moved around and updated to the latest versions. Migration is currently ON by default when using from_file:

pystac/pystac/stac_object.py

Line 633 in 21a0bbb

o = cls.from_dict(d, href=href, migrate=True, preserve_dict=False)

However, it is OFF by default when using from_dict:

pystac/pystac/stac_object.py

Line 650 in 21a0bbb

migrate: bool = False,

This inconsistent behavior is confusing to users (and, tbh, developers). We should align on one. As discussed in #1504, defaulting to migrate=True seems like the best idea for the ecosystem generally.

PR Checklist:

• Pre-commit hooks and tests pass (run scripts/test)
• Documentation has been updated to reflect changes, if applicable
• This PR maintains or improves overall codebase code coverage.
• Changes are added to the CHANGELOG. See the docs for information about adding to the changelog.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.47%. Comparing base (21a0bbb) to head (bb686ab).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1509   +/-   ##
=======================================
  Coverage   91.47%   91.47%           
=======================================
  Files          54       54           
  Lines        7520     7520           
  Branches      910      910           
=======================================
  Hits         6879     6879           
  Misses        457      457           
  Partials      184      184           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jsignell]

Nice!