feat: switch to black from yapf

PySTAC uses black and we do our best to follow PySTAC.
eseglem · Apr 6, 2022 · 7e797b0 · 7e797b0
1 parent 0605c8d
commit 7e797b0
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 30 deletions.
diff --git a/.flake8 b/.flake8
@@ -9,7 +9,4 @@ max-line-length = 100
 # W503, W504: flake8 reports this as incorrect, and scripts/format_code
 # changes code to it, so let format_code win.
 
-# E126: Continuation line over-indented for hanging indent
-# Conflicts with yapf formatting
-
-ignore = E127,W503,W504,E126
+ignore = E127,W503,W504
diff --git a/.readthedocs.environment.yml b/.readthedocs.environment.yml
@@ -7,23 +7,23 @@ dependencies:
   - pip
   - rasterio~=1.2
   - pip:
-    - codespell
-    - coverage
-    - flake8
-    - ipython
-    - jupyter
-    - lxml-stubs
-    - mypy
-    - nbsphinx
-    - pylint
-    - sphinx
-    - sphinx-autobuild
-    - sphinx-click
-    - sphinxcontrib-fulltoc
-    - sphinxcontrib-napoleon
-    - types-certifi
-    - types-orjson
-    - types-python-dateutil
-    - types-requests
-    - yapf
-    - .
+      - black
+      - codespell
+      - coverage
+      - flake8
+      - ipython
+      - jupyter
+      - lxml-stubs
+      - mypy
+      - nbsphinx
+      - pylint
+      - sphinx
+      - sphinx-autobuild
+      - sphinx-click
+      - sphinxcontrib-fulltoc
+      - sphinxcontrib-napoleon
+      - types-certifi
+      - types-orjson
+      - types-python-dateutil
+      - types-requests
+      - .
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,3 +1,4 @@
+black
 codespell
 flake8
 importlib-metadata
@@ -15,10 +16,7 @@ sphinx-autobuild
 sphinx-click
 sphinxcontrib-fulltoc
 sphinxcontrib-napoleon
-# an explicit toml installation is required until https://github.com/google/yapf/commit/fb0fbb47723612608a7c64cb3835562160ea834c is released
-toml
 types-certifi
 types-orjson
 types-python-dateutil
 types-requests
-yapf
diff --git a/scripts/format b/scripts/format
@@ -9,7 +9,7 @@ fi
 function usage() {
     echo -n \
         "Usage: $(basename "$0")
-Format code with yapf
+Format code with black
 "
 }
 
@@ -20,6 +20,6 @@ if [ "${BASH_SOURCE[0]}" = "${0}" ]; then
         usage
     else
         # Code formatting
-        yapf -ipr ${DIRS_TO_CHECK[@]}
+        black ${DIRS_TO_CHECK[@]}
     fi
 fi
diff --git a/scripts/lint b/scripts/lint
@@ -20,7 +20,7 @@ if [ "${BASH_SOURCE[0]}" = "${0}" ]; then
         usage
     else
         # Code formatting
-        yapf -dpr ${DIRS_TO_CHECK[@]}
+        scripts/format
         # Lint
         flake8 ${DIRS_TO_CHECK[@]}
         # Type checking