DM-45243: Migrate to Pydantic v2 and adopt ruff for linting and formatting #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This updates the Makefile to match the current SQuaRE template https://github.com/lsst/templates/blob/main/project_templates/square_pypi_package/example/Makefile One of the advantages of this template is that it uses uv natively.
- Update ci.yaml workflow to be consistent with the current SQuaRE package template - Update to support Python 3.10 to 3.12.
This is based on the SQuaRE PyPI package template.
This includes code changes to fulfill ruff rules.
This drops the use of pkg_resources in favour of importlib in the standard library for discovering and loading entrypoint plugins.
Typer doesn't support modern syntax for optional types like Path | None. To prevent ruff from auto-upgrading the syntax we're using a noqa for UP007 for now.
With ruff we're encouraged to make run_post_build an abstract method which requires all plugin implementations to then have an implementation of the method. I'm not sure this is a good idea or not, but this is required at the moment.
With Pydantic 2, the custom orcid and ror URL types were difficult to re-implement. Instead, I'm treating those as regular HttpUrl types and using functional validators to validate the IDs. Similarly, the CollapsedWhitespacestr functional validator replaces the multi-field whitespace validator in the original DocumentMetadata model.
This is done because the UTC time zone is not available in Python 3.10.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backwards-incompatible changes
Upgrade to Pydantic version 2. With this new Pydantic version, the custom Orcid and Ror types in the DocumentMetadata model are now implemented as functional validators with annotations.
Python version compatibility is now Python 3.10 and later.
Theme plugins are now required to implement a
run_post_buildmethod that post-processes the Lander site build. This method can be a no-op.New features
pkg_resources.Other changes