Use ruff #1994
Use ruff #1994
Conversation
github-actions
bot
added
datasets
github-actions
bot
added
the
documentation
| "ms-python.python", | ||
| "ms-python.isort", | ||
| "ms-python.black-formatter", | ||
| "ms-python.vscode-pylance", |
There was a problem hiding this comment.
Got rid of pylance since we aren't currently using it anywhere else. Also, haven't tested this file since I don't know how to use it.
.pre-commit-config.yaml
Outdated
There was a problem hiding this comment.
@ashnair1 can you test this?
I'm wondering if we should remove mypy from pre-commit since it's so slow.
We could also add the pre-commit action so that fixes are automatically applied to PRs.
There was a problem hiding this comment.
Tested the file and it works fine.
The slowness observed in the mypy hook occurs when there is a change in the additional dependencies as the isolated environment (where pre-commit runs the hooks) needs to be recreated. Once it's done, subsequent runs will be faster.
Incorporating the pre-commit action is a good idea. That way, new contributors won't have to worry about style. From a CI perspective, since we already have a Github action for checking mypy, we theoretically wouldn't need a mypy hook in the pre-commit config anymore.
On the flip side, having the mypy hook in the pre-commit config is useful for testing mypy when you don't have the latest versions of the libraries installed locally :)
| "from torchgeo.trainers import ClassificationTask\n", | ||
| "from torchgeo.models import ResNet18_Weights" | ||
| "from torchgeo.models import ResNet18_Weights\n", | ||
| "from torchgeo.trainers import ClassificationTask" |
There was a problem hiding this comment.
Seems like isort and pyupgrade did not have Jupyter notebook support
| # tests | ||
| mypy==0.900 | ||
| nbmake==1.3.3 |
There was a problem hiding this comment.
We don't actually run any docs/style tests with the min version, no need to install those deps.
| @@ -1,5 +1,4 @@ | |||
| # tests | |||
| mypy==1.9.0 | |||
There was a problem hiding this comment.
I moved "mypy" under "style" in CI but forgot to move it in the requirements files.
| ), "You have selected an invalid country, please choose one of {}".format( | ||
| self.all_countries | ||
| ) | ||
| ), f"You have selected an invalid country, please choose one of {self.all_countries}" |
There was a problem hiding this comment.
| @@ -293,12 +293,12 @@ def _extract(self) -> None: | |||
| features_path = os.path.join(self.root, self.file_dict["features"]["filename"]) | |||
| extract_archive(features_path) | |||
|
|
|||
| def plot(self, sample: dict[str, Tensor], subtitle: str | None = None) -> Figure: | |||
| def plot(self, sample: dict[str, Tensor], suptitle: str | None = None) -> Figure: | |||
There was a problem hiding this comment.
Actual bug caught by pydocstyle!
| transforms: a function/transform that takes input sample and its target as | ||
| entry and returns a transformed version | ||
| download: if True, download dataset and store it in the root directory |
There was a problem hiding this comment.
Lots of missing parameters in the docs
| @@ -290,7 +291,7 @@ def _load_files(self, root: str) -> list[dict[str, Any]]: | |||
|
|
|||
| images = imgs_no_subcat + imgs_subcat | |||
|
|
|||
| files = [dict(image=img, label=l) for img, l in zip(images, labels)] | |||
| files = [dict(image=image, label=label) for image, label in zip(images, labels)] | |||
There was a problem hiding this comment.
Linter complained about l being ambiguous (l vs. 1)
|
I actually plan to expand the number of rules (stricter pydocstyle) and make some other formatting changes (double -> single quotes) but will save that for another PR. So far, this PR simply replaces our current tools with a single, faster, less buggy tool. |
|
I've tried rerunning the minimum tests 5 or 6 times but no luck. Pretty sure codecov is dead: #1995 |
|
Shall we merge w/o codecov passing? |
|
How fast is this now? |
Before> time begin; black .; flake8; isort .; pydocstyle; pyupgrade --py310-plus $(find . -path ./docs/src -prune -o -name "*.py" -print); end
...
Executed in 7.18 secs fish external
usr time 12.33 secs 1.30 millis 12.33 secs
sys time 2.74 secs 9.48 millis 2.73 secsAfter> time begin; ruff check; ruff format; end
...
Executed in 83.13 millis fish external
usr time 48.57 millis 0.17 millis 48.41 millis
sys time 83.33 millis 2.75 millis 80.58 millis |
Closes #1986