Merge pull request #29 from SnappyLab/feature/15-add-automated-linting-to-the-ci

Added ruff linting

Author: PaoloLeonard

.github/workflows/docbinder-oss.yml

@@ -40,6 +40,11 @@ jobs:
         run: |
           uv sync --locked --all-extras --dev
 
+      - name: Lint code with uv
+        run: |
+          uv tool run ruff check --fix
+          uv tool run ruff format
+
       - name: Run tox with uv
         run: |
           uv run tox -e ${{ matrix.tox-env }}

pyproject.toml

@@ -43,3 +43,13 @@ addopts = "-ra -q"
 testpaths = [
     "tests",
 ]
+
+[tool.ruff]
+# Set the maximum line length to 100.
+line-length = 100
+
+[tool.ruff.lint]
+# Add the `line-too-long` rule to the enforced rule set. By default, Ruff omits rules that
+# overlap with the use of a formatter, like Black, but we can override this behavior by
+# explicitly adding the rule.
+extend-select = ["E501"]

src/docbinder_oss/main.py

@@ -115,7 +115,8 @@ def get_provider(
             count += 1
         if provider.type == connection_type:
             typer.echo(
-                f"Provider '{provider.name}' of type '{connection_type}' found with config: {provider}"
+                f"Provider '{provider.name}' of type "
+                f"'{connection_type}' found with config: {provider}"
             )
             count += 1
     if count == 0:

src/docbinder_oss/services/google_drive/google_drive_files.py

@@ -6,7 +6,12 @@
 
 logger = logging.getLogger(__name__)
 
-REQUIRED_FIELDS = "id,name,mimeType,kind,size,createdTime,modifiedTime,owners(permissionId,displayName,emailAddress,photoLink),lastModifyingUser(permissionId,displayName,emailAddress,photoLink),webViewLink,iconLink,trashed,shared,starred"
+REQUIRED_FIELDS = (
+    "id,name,mimeType,kind,size,createdTime,modifiedTime,"
+    "owners(permissionId,displayName,emailAddress,photoLink),"
+    "lastModifyingUser(permissionId,displayName,emailAddress,photoLink),"
+    "webViewLink,iconLink,trashed,shared,starred"
+)
 
 
 class GoogleDriveFiles:

src/docbinder_oss/services/google_drive/google_drive_permissions.py

@@ -25,7 +25,9 @@ def get_user(self):
             display_name=user_info.get("displayName"),
             email_address=user_info.get("emailAddress"),
             photo_link=user_info.get("photoLink"),
-            kind="drive#user",  # 'kind' is not always present in the User schema, so we set it to "drive#user" by default
+            # 'kind' is not always present in the User schema, so we set it to "drive#user"
+            #  by default
+            kind="drive#user",
         )
 
     def get_permissions(self, item_id: str):
@@ -45,7 +47,9 @@ def get_permissions(self, item_id: str):
                     display_name=perm.get("displayName"),
                     email_address=perm.get("emailAddress"),
                     photo_link=perm.get("photoLink"),
-                    kind="drive#user",  # 'kind' is not always present in the User schema, so we set it to "drive#user" by default
+                    # 'kind' is not always present in the User schema, so we set it to "drive#user"
+                    #  by default
+                    kind="drive#user",
                 ),
                 domain=perm.get("domain"),
                 deleted=perm.get("deleted"),

tests/services/google_drive/__init__.py

@@ -42,6 +42,8 @@ def gdrive_client(mock_gdrive_service):
         return_value=MagicMock(),
     ):
         config = GoogleDriveServiceConfig(
-            name="test_gdrive", gcp_credentials_json="fake_creds.json", gcp_token_json="fake_token.json"
+            name="test_gdrive",
+            gcp_credentials_json="fake_creds.json",
+            gcp_token_json="fake_token.json",
         )
         return GoogleDriveClient(config=config)

tests/services/google_drive/conftest.py

@@ -18,7 +18,9 @@ def test_get_permissions(mock_gdrive_service, gdrive_client):
             }
         ]
     }
-    mock_gdrive_service.permissions.return_value.list.return_value.execute.return_value = fake_api_response
+    mock_gdrive_service.permissions.return_value.list.return_value.execute.return_value = (
+        fake_api_response
+    )
 
     permissions = gdrive_client.get_permissions("1234")