Merge pull request #1087 from gboeing/ruff

update ruff config and replace black with ruff format

.github/workflows/ci.yml

@@ -46,13 +46,10 @@ jobs:
       - name: Lint code
         run: |
           SKIP=no-commit-to-branch pre-commit run --all-files
-          hatch build --clean
-          twine check --strict ./dist/*
 
       - name: Test docs
         run: |
           make -C ./docs html
-          python -m sphinx -b linkcheck docs/source build/linkcheck
 
       - name: Test code
         run: pytest --cov=./osmnx --cov-report=xml --cov-report=term-missing --verbose

.pre-commit-config.yaml

@@ -24,17 +24,14 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.0.3"
+    rev: "v3.1.0"
     hooks:
       - id: prettier
         types_or: [markdown, yaml]
 
-  - repo: https://github.com/psf/black
-    rev: "23.9.1"
-    hooks:
-      - id: black
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.0.292"
+    rev: "v0.1.6"
     hooks:
       - id: ruff
+        args: [--fix]
+      - id: ruff-format

environments/docker/requirements.txt

@@ -31,7 +31,6 @@ pip
 twine
 
 # linting/testing
-black
 nbdime
 nbqa
 pre-commit

pyproject.toml

@@ -49,11 +49,9 @@ visualization = ["matplotlib>=3.5"]
 
 [project.urls]
 Documentation = "https://osmnx.readthedocs.io"
+Gallery = "https://github.com/gboeing/osmnx-examples"
 Repository = "https://github.com/gboeing/osmnx"
 
-[tool.black]
-line_length = 100
-
 [tool.hatch.build]
 packages = ["osmnx"]
 
@@ -63,23 +61,26 @@ path = "osmnx/_version.py"
 [tool.ruff]
 cache-dir = "~/.cache/ruff"
 exclude = ["build/*"]
-ignore = ["PLR091"]  # ignore complexity checks (we check mccabe elsewhere)
-line-length = 110  # black line length + 10%
-select = [
+line-length = 100
+target-version = "py38"
+
+[tool.ruff.lint]
+extend-ignore = ["PLR091"]  # ignore PLR complexity checks (we check mccabe with C9)
+extend-select = [
     "A",    # check python builtins being used as variables or parameters
     "ARG",  # check unused function arguments
     "B",    # check common design problems a la flake8-bugbear
     "BLE",  # check for blind exception catching
     "C4",   # check proper comprehensions
     "C9",   # check mccabe complexity
     "D",    # check docstring conventions a la pydocstyle
+    "D417", # check missing arguments in docstrings (disabled by default for numpy convention)
     "DTZ",  # check unsafe naive datetime use a la flake8-datetimez
     "E",    # check code style conventions a la pycodestyle errors
     "EM",   # check raw literals inside exception raising
     "ERA",  # check commented-out code from python files a la eradicate
     "F",    # check python source code for errors a la pyflakes
     "I",    # check isort imports
-    "ISC",  # check implicit string literal concatenation
     "PERF", # check performance anti-patterns a la perflint
     "PGH",  # check pygrep hooks
     "PIE",  # check misc lints a la flake8-pie
@@ -92,21 +93,23 @@ select = [
     "UP",   # check outdated syntax a la pyupgrade
     "W",    # check code style conventions a la pycodestyle warnings
 ]
-target-version = "py38"
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 force-single-line = true
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 14
 
+[tool.ruff.lint.pycodestyle]
+max-line-length = 110  # line length + 10% since it isn't a hard upper bound
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
 [tool.ruff.per-file-ignores]
 "./osmnx/_api.py" = ["F401"]  # allow API imports to go unused
 "./tests/test_osmnx.py" = [
     "E402",    # allow imports not at the top of the file
     "F841",    # allow unused local variables
     "PLR2004", # allow magic values in comparisons
 ]
-
-[tool.ruff.pydocstyle]
-convention = "numpy"

tests/environments/env-ci.yml

@@ -22,7 +22,6 @@ dependencies:
   - scipy
 
   # linting/testing
-  - black=23
   - hatch
   - pre-commit
   - pytest

tests/environments/env-test-minimal.yml

@@ -25,7 +25,6 @@ dependencies:
   - scipy=1.5
 
   # linting/testing
-  - black=23
   - hatch
   - pre-commit
   - pytest

tests/format.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 ruff check . --fix-only
-black .
+ruff format .

tests/packaging.sh

@@ -22,7 +22,7 @@ VERSION=$(hatch version)
 rm -rf ./dist
 hatch build --clean
 twine check --strict ./dist/*
-SHA=$(openssl dgst -sha256 -r "./dist/$PACKAGE-$VERSION.tar.gz"  | awk '{print $1}')
+SHA=$(openssl dgst -sha256 -r "./dist/$PACKAGE-$VERSION.tar.gz" | awk '{print $1}')
 
 # rerender the conda-forge feedstock
 cd ../$PACKAGE-feedstock