Merge pull request #1291 from VWS-Python/yapf-to-black

Switch from yapf to black

Author: adamtheturtle

Makefile

@@ -7,6 +7,7 @@ SPHINXOPTS := -W
 
 .PHONY: lint
 lint: \
+    black \
     check-manifest \
     doc8 \
     flake8 \
@@ -21,12 +22,11 @@ lint: \
     vulture \
     pylint \
     pydocstyle \
-    yapf
 
 .PHONY: fix-lint
 fix-lint: \
     autoflake \
-    fix-yapf \
+    fix-black \
     fix-isort
 
 .PHONY: docs

dev-requirements.txt

@@ -1,5 +1,6 @@
 # We use dev-requirements.txt instead of just declaring the requirements in
 # the setup function because Read The Docs needs a requirements file.
+black==20.8b1
 PyYAML==5.3.1
 Pygments==2.6.1
 Sphinx-Substitution-Extensions==2020.7.4.1
@@ -29,4 +30,3 @@ sphinxcontrib-spelling==5.3.0
 twine==3.2.0
 versioneer==0.18
 vulture==2.1
-yapf==0.30.0  # Automatic formatting for Python

lint.mk

@@ -2,21 +2,13 @@
 
 SHELL := /bin/bash -euxo pipefail
 
-.PHONY: yapf
-yapf:
-	yapf \
-	    --diff \
-	    --recursive \
-	    --exclude .eggs \
-	    .
+.PHONY: black
+black:
+	black --check .
 
-.PHONY: fix-yapf
-fix-yapf:
-	yapf \
-	    --in-place \
-	    --recursive \
-	    --exclude .eggs \
-	    .
+.PHONY: fix-black
+fix-black:
+	black .
 
 .PHONY: mypy
 mypy:

pyproject.toml

@@ -45,7 +45,10 @@
         'too-many-arguments',
         'too-many-instance-attributes',
         'too-many-return-statements',
+        'too-many-lines',
         'locally-disabled',
+        # Let flake8 handle long lines
+        'line-too-long',
         # Let flake8 handle unused imports
         'unused-import',
         # Let isort deal with sorting
@@ -54,9 +57,9 @@
         'missing-type-doc',
         'missing-returns-doc',
         'missing-return-type-doc',
-        # Let YAPF deal with this
+        # Let auto-formatters deal with this
         'bad-continuation',
-        # Let YAPF deal with this
+        # Let auto-formatters deal with this
         'bad-whitespace',
         # Too difficult to please
         'duplicate-code',
@@ -82,3 +85,8 @@
     # Tells whether to store unknown words to indicated private dictionary in
     # --spelling-private-dict-file option instead of raising a message.
     spelling-store-unknown-words = 'no'
+
+[tool.black]
+
+line-length = 79
+skip-string-normalization = true

setup.cfg

@@ -97,10 +97,6 @@ include_trailing_comma=true
 [coverage:run]
 branch = True
 
-[yapf]
-DEDENT_CLOSING_BRACKETS = true
-BLANK_LINE_BEFORE_NESTED_CLASS_OR_DEF = true
-
 [metadata]
 name = VWS Python
 description = Interact with the Vuforia Web Services (VWS) API.

src/vws/query.py

@@ -46,8 +46,9 @@ def query(
         self,
         image: io.BytesIO,
         max_num_results: int = 1,
-        include_target_data:
-        CloudRecoIncludeTargetData = CloudRecoIncludeTargetData.TOP,
+        include_target_data: CloudRecoIncludeTargetData = (
+            CloudRecoIncludeTargetData.TOP
+        ),
     ) -> List[QueryResult]:
         """
         Use the Vuforia Web Query API to make an Image Recognition Query.
@@ -89,8 +90,11 @@ def query(
         body = {
             'image': ('image.jpeg', image_content, 'image/jpeg'),
             'max_num_results': (None, int(max_num_results), 'text/plain'),
-            'include_target_data':
-            (None, include_target_data.value, 'text/plain'),
+            'include_target_data': (
+                None,
+                include_target_data.value,
+                'text/plain',
+            ),
         }
         date = rfc_1123_date()
         request_path = '/v1/query'

tests/test_vws.py

@@ -336,18 +336,23 @@ def test_default_seconds_between_requests(
             report = vws_client.get_database_summary_report()
             expected_requests = (
                 # Add target request
-                1 +
+                1
+                +
                 # Database summary request
-                1 +
+                1
+                +
                 # Initial request
-                1 +
+                1
+                +
                 # Request after 0.2 seconds - not processed
-                1 +
+                1
+                +
                 # Request after 0.4 seconds - not processed
                 # This assumes that there is less than 0.1 seconds taken
                 # between the start of the target processing and the start of
                 # waiting for the target to be processed.
-                1 +
+                1
+                +
                 # Request after 0.6 seconds - processed
                 1
             )
@@ -386,16 +391,20 @@ def test_custom_seconds_between_requests(
             report = vws_client.get_database_summary_report()
             expected_requests = (
                 # Add target request
-                1 +
+                1
+                +
                 # Database summary request
-                1 +
+                1
+                +
                 # Initial request
-                1 +
+                1
+                +
                 # Request after 0.3 seconds - not processed
                 # This assumes that there is less than 0.2 seconds taken
                 # between the start of the target processing and the start of
                 # waiting for the target to be processed.
-                1 +
+                1
+                +
                 # Request after 0.6 seconds - processed
                 1
             )