Merge pull request #3 from scrapy-plugins/feature/pre-commit

Feature/pre commit

Author: VMRuiz

.flake8

@@ -0,0 +1,37 @@
+[flake8]
+ignore =
+    E501,  
+    # "max-line length" - Handled by black.
+    W503,  
+    # "line break before binary operator" - Handled by black.
+
+    D100,  
+    # Missing docstring in public module
+    D101,  
+    # Missing docstring in public class
+    D103,  
+    # Missing docstring in public function
+    D102,  
+    # Missing docstring in public method
+    D104,  
+    # Missing docstring in public package
+    D105,  
+    # Missing docstring in magic method
+    D107,  
+    # Missing docstring in __init__
+    D200,  
+    # One-line docstring should fit on one line with quotes
+    D202,  
+    # No blank lines allowed after function docstring
+    D205,  
+    # 1 blank line required between summary line and description
+    D209,  
+    # Multi-line docstring closing quotes should be on a separate line
+    D400,  
+    # First line should end with a period
+    D401,  
+    # First line should be in imperative mood
+    D402,  
+    # First line should not be the function's "signature"
+    P103,  
+    # Other string does contain unindexed parameters

.git-blame-ignore-revs

@@ -0,0 +1 @@
+d2d60666e425eeda24b7735702978b7dbef509f9

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+default_language_version:
+    python: python3.10
+repos:
+  - hooks:
+      - id: black
+        language_version: python3
+    repo: https://github.com/ambv/black
+    rev: 24.2.0
+  - hooks:
+      - id: isort
+        language_version: python3
+    repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+  - hooks:
+      - id: flake8
+        language_version: python3
+        additional_dependencies:
+          - flake8-bugbear
+          - flake8-comprehensions
+          - flake8-debugger
+          - flake8-docstrings
+          - flake8-string-format
+    repo: https://github.com/pycqa/flake8
+    rev: 7.0.0

pyproject.toml

@@ -1,3 +1,6 @@
 [build-system]
 requires = ['setuptools>=42']
-build-backend = 'setuptools.build_meta'
+build-backend = 'setuptools.build_meta'
+
+[tool.isort]
+profile = "black"

src/scrapy_settings_log/__init__.py

@@ -1,13 +1,11 @@
-import logging
 import inspect
 import json
+import logging
 import re
-
-from collections.abc import Mapping, Iterable
+from collections.abc import Iterable, Mapping
 
 import scrapy
 from scrapy import signals
-from scrapy.settings import BaseSettings
 
 logger = logging.getLogger(__name__)
 
@@ -25,7 +23,10 @@ def prepare_for_json_serialization(obj):
     if isinstance(obj, (str, int, float, bool)) or obj is None:
         return obj
     elif isinstance(obj, Mapping):
-        return {str(prepare_for_json_serialization(k)): prepare_for_json_serialization(v) for k, v in obj.items()}
+        return {
+            str(prepare_for_json_serialization(k)): prepare_for_json_serialization(v)
+            for k, v in obj.items()
+        }
     elif isinstance(obj, Iterable):
         return [prepare_for_json_serialization(v) for v in obj]
     elif inspect.isclass(obj):

tests/test_code.py

@@ -1,7 +1,9 @@
+import logging
+
 from scrapy import Spider
 from scrapy.crawler import Crawler
+
 from src.scrapy_settings_log import SpiderSettingsLogging
-import logging
 
 LOGGER = logging.getLogger(__name__)
 
@@ -93,11 +95,11 @@ class CustomClass:
     settings = {
         "SETTINGS_LOGGING_ENABLED": True,
         "SETTINGS_LOGGING_REGEX": "DUMMY",
-        "DUMMY_CUSTOM_CLASS": {CustomClass: "/foo/bar"}
+        "DUMMY_CUSTOM_CLASS": {CustomClass: "/foo/bar"},
     }
     spider = MockSpider(settings)
     logger = SpiderSettingsLogging()
     with caplog.at_level(logging.INFO):
         logger.spider_closed(spider)
 
-    assert '{"DUMMY_CUSTOM_CLASS": {"CustomClass": "/foo/bar"}}' in  caplog.text
+    assert '{"DUMMY_CUSTOM_CLASS": {"CustomClass": "/foo/bar"}}' in caplog.text

tests/test_process_values.py

@@ -1,30 +1,43 @@
 from src.scrapy_settings_log import prepare_for_json_serialization
 
+
 def test_prepare_for_json_serialization_with_set():
     """Test processing a set value."""
-    obj = {1,2,3}
+    obj = {1, 2, 3}
     result = prepare_for_json_serialization(obj)
-    assert result == [1,2,3]
+    assert result == [1, 2, 3]
 
 
 def test_prepare_for_json_serialization_with_class_object():
     """Test processing a class object."""
+
     class DummyClass:
         pass
+
     result = prepare_for_json_serialization(DummyClass)
     assert result == "DummyClass"
 
 
 def test_prepare_for_json_serialization_dict_with_class_as_key():
     """Test processing a dictionary with a class object as a key."""
+
     class DummyClass:
         pass
+
     result = prepare_for_json_serialization({DummyClass: "foo"})
     assert result == {"DummyClass": "foo"}
 
 
 def test_prepare_for_json_serialization_with_nested_objects():
     """Test processing nested objects."""
-    obj = {"foo": {"bar": {1,2,3,}}}
+    obj = {
+        "foo": {
+            "bar": {
+                1,
+                2,
+                3,
+            }
+        }
+    }
     result = prepare_for_json_serialization(obj)
-    assert result == {"foo": {"bar": [1,2,3]}}
+    assert result == {"foo": {"bar": [1, 2, 3]}}