Adopt ruff as the central tool for linting, formatting, and import sorting
#702
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
github-actions
bot
added
type: devops
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #702 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 15 15
Lines 1546 1546
=========================================
Hits 1546 1546 ☔ View full report in Codecov by Sentry. |
tomvothecoder
commented
Oct 2, 2024
| @@ -847,7 +847,7 @@ def test_add_monthly_bounds_for_end_of_month_set_to_true(self): | |||
| # Get time axis and create new axis with time set to first day of month. | |||
| time = ds_with_bnds.time | |||
| new_time = [] | |||
| for i, t in enumerate(time.values): | |||
| for _, t in enumerate(time.values): | |||
There was a problem hiding this comment.
| @@ -663,7 +668,7 @@ def test_map_latitude_coarse_to_fine(self): | |||
| np.testing.assert_allclose(x, y) | |||
|
|
|||
| for x2, y2 in zip(weights, expected_weigths): | |||
| np.testing.assert_allclose(x, y) | |||
| np.testing.assert_allclose(x2, y2) | |||
There was a problem hiding this comment.
| @@ -1254,7 +1259,7 @@ def test_grid(self): | |||
| ValueError, | |||
| match=r".*lon\d?.*lon\d?.*", | |||
| ): | |||
| ds_multi.regridder.grid | |||
| ds_multi.regridder.grid # noqa: B018 | |||
There was a problem hiding this comment.
Ignores B018 - useless-expression
| @@ -44,7 +44,7 @@ | |||
| def open_dataset( | |||
| path: str | os.PathLike[Any] | BufferedIOBase | AbstractDataStore, | |||
| data_var: Optional[str] = None, | |||
| add_bounds: List[CFAxisKey] | None = ["X", "Y"], | |||
| add_bounds: List[CFAxisKey] | Tuple[CFAxisKey, ...] | None = ("X", "Y"), | |||
There was a problem hiding this comment.
Comment on lines
127
to
131
| def add_missing_bounds( # noqa: C901 | ||
| self, axes: List[CFAxisKey] = ["X", "Y", "T"] | ||
| self, axes: List[CFAxisKey] | Tuple[CFAxisKey, ...] = ("X", "Y", "T") | ||
| ) -> xr.Dataset: |
There was a problem hiding this comment.
Comment on lines
+151
to
+154
| except KeyError as e: | ||
| raise RuntimeError( | ||
| "Could not determine 'Z' coordinate in output dataset" | ||
| ) from e |
There was a problem hiding this comment.
Comment on lines
+170
to
+174
| except KeyError as e: | ||
| if self._target_data is not None and isinstance(self._target_data, str): | ||
| raise RuntimeError( | ||
| f"Could not find target variable {self._target_data!r} in dataset" | ||
| ) | ||
| ) from e |
There was a problem hiding this comment.
Comment on lines
+221
to
+222
| except KeyError as e: | ||
| raise RuntimeError("Could not determine `Z` coordinate in dataset.") from e |
There was a problem hiding this comment.
Comment on lines
+236
to
+237
| except KeyError as e: | ||
| raise RuntimeError("Could not determine `Z` bounds in dataset.") from e |
There was a problem hiding this comment.
Comment on lines
+963
to
+968
| except (IndexError, ValueError) as e: | ||
| raise ValueError( | ||
| "Reference periods must be a tuple of strings with the format " | ||
| "'yyyy-mm-dd'. For example, reference_period=('1850-01-01', " | ||
| "'1899-12-31')." | ||
| ) | ||
| ) from e |
There was a problem hiding this comment.
tomvothecoder
force-pushed
the
devops/592-ruff
branch
from
4581444
to
545d19b
Compare
|
@xCDAT/core-developers happy to hear thoughts if any of you care about this like I do. All you need to do on your end is reinstall your conda dev env and |
|
I trust you. |
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
flake8linter,blackformatter, andisortwithruff#592Why ruff?
flake8,black, andisortflake8,black, andisortout-of-the-boxflake8-docstringsandflake8-bugbearSummary of changes
flake8,black, andisort/flake8-isortwith a single tool,ruffin conda dev environment andpre-commitruffaxes=["X", "Y"]). It is bad practice to set default arguments to a mutable object: https://docs.astral.sh/ruff/rules/mutable-argument-default/#why-is-this-badtuplesshould be usedregridder/__init__.pyWhat do contributors need to do?
conda env create -f conda/dev.ymlxcdatrepo:pre-commit installpre-commit installFuture TODOs
flake8-docstringforruffinpyproject.tomland fix docstring issuesChecklist
If applicable: