Add pre commit config

[ocefpaf]

Closes #66

[ocefpaf]

I'll enable that in another PR to avoid a lot of code churn.

[ocefpaf]

The code base uses docstrings as a way to do multi-line comment. We need to change that to be able to build clear docs and to run this check.

[ChrisBarker-NOAA]

It passes Ruff as is -- though I think that's a bad practice, so it would be good to clean that up. Maybe now, as that would make for less churn later.

Ideally, major format changes happen all in one commit ...

But your call, either way is good with me.

[ocefpaf]

This project uses a small subset of all the lints ruff can run. While we can enable "ruff all" at some point, this particular line is focused on better docs rendering. I'll address it later b/c it may require some group discussion.

[ChrisBarker-NOAA]

I'm a bit confused -- we hve ruff config in the pyproject.yaml, currently:

[tool.ruff]
builtins = ["ellipsis"]
extend-exclude = ["xarray_subset_grid/_version.py"]
target-version = "py310"
# Use a longer line length.
line-length = 100

[tool.ruff.lint]
ignore = [
  "E402", # module level import not at top of file
  "E731", # do not assign a lambda expression, use a def
]
select = [
  "F",   # Pyflakes
  "E",   # Pycodestyle
  "W",
  "TID", # flake8-tidy-imports (absolute imports)
  "I",   # isort
  "UP",  # Pyupgrade
]
extend-safe-fixes = [
  "TID252", # absolute imports
]

So shouldn't we simply call ruff check --fix (or whatever the incantation is) and leave all the config in the pyproject file?

But in any case -- yes, as for right now, minimal churn, and we can decide to nail down / update the project style requirements in the future.

[ocefpaf]

That is what pre-commit does.

[ocefpaf]

If folks want to adopt ruff format in lieu of black, we should do that ASAP to avoid a lot of churn in the code base as the code grows in size.

[ChrisBarker-NOAA]

see below -- yes, let's use ruff.

[ocefpaf]

Ruff format is one of the ruff lint's that is not used here. It is recommended as a black substitute. None of the selected ruff lints in the project.toml implements ruff format.

[ChrisBarker-NOAA]

Got it -- I added some ruff format config, and ran it, in the reformat branch.

It seems to have done a fine job, with not a lot of disruption.

Can you merge that in to this pre-commit branch and see how it goes?

[ocefpaf]

I'll enable this one after #65 b/c that PR already fixes most if it.

[ChrisBarker-NOAA]

Yes, let's stick with ruff -- that's what we've been using, and it currently passes a ruff check (as configured in the pyproject.yaml).

[ocefpaf]

@ChrisBarker-NOAA the sdist is way too big and, before we publish this on PyPI, let me work on it a little bit to remove all test data from the sdist. Otherwise we risk reaching storage quota with just a few releases.

41M Jun  6 15:47 xarray_subset_grid-0.0.2.dev6+ga442a7d.d20250606.tar.gz

[ocefpaf]

@ChrisBarker-NOAA this one is ready to go. I'll work on the data and test organization after it.

[ChrisBarker-NOAA]

Thanks!

[ChrisBarker-NOAA]

One question -- blackdoc formats code in docstrings, yes?

Doesn't ruff have that as well (at least as an option?) -- though as long as they do the same thing, no harm no foul.

[ocefpaf]

One question -- blackdoc formats code in docstrings, yes?

Yes.

Doesn't ruff have that as well (at least as an option?) -- though as long as they do the same thing, no harm no foul.

One needs:

[tool.ruff.format]
docstring-code-format = true

In the pyproject.toml. I never used it in the past b/c it is kind of a new feature. If you want to use it we can add that line and remove blackdoc.