enable ruff linters

Author: mr-mixas

nested_diff_restful/__init__.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 # Copyright 2024 Michael Samoglyadov
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,6 +22,7 @@
 
 def start_wsgi_server():
     import gunicorn.app.base
+
     import nested_diff_restful.api
 
     class WSGIServer(gunicorn.app.base.Application):

nested_diff_restful/api.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 # Copyright 2021-2024 Michael Samoglyadov
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,18 +15,16 @@
 import os
 
 from flask import Flask, Response, jsonify, render_template, request
-
 from nested_diff import Differ, Patcher
-from nested_diff.formatters import HtmlFormatter, TextFormatter, TermFormatter
+from nested_diff.formatters import HtmlFormatter, TermFormatter, TextFormatter
 from nested_diff.handlers import TextHandler
 
-
 flask_kwargs = {}
 
 for kw in ('static_folder', 'static_url_path', 'template_folder'):
     try:
         flask_kwargs[kw] = os.environ['NESTED_DIFF_REST_' + kw.upper()]
-    except KeyError:
+    except KeyError:  # noqa: PERF203
         pass
 
 app = Flask(__name__, **flask_kwargs)
@@ -76,7 +72,7 @@ def diff():
     try:
         old = request.json.get('a', None)
         new = request.json.get('b', None)
-    except Exception:
+    except Exception:  # noqa: BLE001
         return Response('Bad request', status=400)
 
     try:
@@ -87,7 +83,7 @@ def diff():
 
         if text_diff_ctx >= 0:
             differ.set_handler(TextHandler(context=text_diff_ctx))
-    except Exception:
+    except Exception:  # noqa: BLE001
         return Response('Incorrect diff options', status=400)
 
     _, diff = differ.diff(old, new)
@@ -102,7 +98,7 @@ def diff():
 
 
 @app.route('/api/v1/format', methods=['POST'])
-def format():
+def format_diff():
     try:
         diff = request.json.get('diff', {})
         ofmt = request.json.get('ofmt', None)
@@ -112,7 +108,7 @@ def format():
         ofmt_opts = request.json.get('ofmt_opts', {})
 
         return format_diff_response(ofmt, diff, ofmt_opts)
-    except Exception:
+    except Exception:  # noqa: BLE001
         return Response('Incorrect arguments', status=400)
 
 
@@ -123,9 +119,9 @@ def patch():
             Patcher().patch(
                 request.json['target'],
                 request.json['patch'],
-            )
+            ),
         )
-    except Exception:
+    except Exception:  # noqa: BLE001
         return Response('Incorrect arguments', status=400)
 
 
@@ -155,5 +151,5 @@ def nested_diff_script():
     app.run(
         host=os.environ.get('NESTED_DIFF_REST_HOST', 'localhost'),
         port=os.environ.get('NESTED_DIFF_REST_PORT', 8080),
-        debug=True if 'NESTED_DIFF_REST_DEBUG' in os.environ else False,
+        debug='NESTED_DIFF_REST_DEBUG' in os.environ,
     )

pyproject.toml

@@ -30,6 +30,7 @@ test = [
     'pytest',
     'pytest-cov',
     'pytest-ruff',
+    'ruff==0.1.15',  # pin version for reproducible results
 ]
 
 [project.urls]
@@ -49,6 +50,23 @@ addopts = """
 
 [tool.ruff]
 line-length = 79
+select = ['ALL']
+ignore = [
+    'ANN',  # type annotations
+    'D',  # docstrings
+    'SIM105',  # contextlib.suppress is slower than try-except-pass
+]
+
+[tool.ruff.extend-per-file-ignores]
+'tests/*' = [
+    'E501',  # long lines
+    'PLR2004',  # hardcoded value used in comparison
+    'S101',  # use of `assert`
+]
 
 [tool.ruff.format]
 quote-style = 'single'
+
+[tool.ruff.lint]
+flake8-quotes.inline-quotes = 'single'
+isort.lines-between-types = 1

tests/conftest.py

@@ -3,7 +3,7 @@
 from nested_diff_restful.api import app
 
 
-@pytest.fixture
+@pytest.fixture()
 def client():
     with app.test_client() as client:
         yield client

tests/test_api_patch.py

@@ -6,7 +6,8 @@ def test_invalid_request(client):
 
 def test_patch(client):
     rv = client.post(
-        '/api/v1/patch', json={'target': 'a', 'patch': {'N': 'b'}}
+        '/api/v1/patch',
+        json={'target': 'a', 'patch': {'N': 'b'}},
     )
 
     assert rv.status_code == 200

tests/test_cli.py

@@ -1,6 +1,7 @@
-import pytest
 import unittest.mock
 
+import pytest
+
 import nested_diff_restful