Enable ruff's flake8-future-annotations (FA) rules #2855
Merged
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
``` pygmt/datasets/load_remote_dataset.py:61:12: FA100 Missing `from __future__ import annotations`, but uses `typing.Union` | 59 | name: str 60 | long_name: str 61 | units: Union[str, None] | ^^^^^ FA100 62 | resolutions: dict[str, Resolution] 63 | extra_attributes: dict | ```
``` pygmt/datasets/load_remote_dataset.py:63:12: UP007 Use `X | Y` for type annotations | 61 | name: str 62 | long_name: str 63 | units: Union[str, None] | ^^^^^^^^^^^^^^^^ UP007 64 | resolutions: dict[str, Resolution] 65 | extra_attributes: dict | = help: Convert to `X | Y` ```
seisman
added
maintenance
7 tasks
yvonnefroehlich
approved these changes
Dec 8, 2023
seisman
added
final review call
seisman
removed
the
final review call
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.
Description of proposed changes
Enable ruff's flake8-future annotations (FA) rules. This rule set contains two rules, FA100 and FA102.
Generally, these two rules recommend using
from __future__ import annotationsso that we can use some new type hinting syntax in old Python versions. For example,Union[str, None]can be rewritten asstr | Nonefor Python>=3.10 (introduced in PEP 604). It won't work for Python 3.9 (PyGMT's minimum supported Python version) unless we usefrom __future__ import annotations.For more details, please refer to: