Replaces flake8 with ruff and associated fixes. (Netflix#2998)

* Fixing ruff suggestions

Author: kevgliss

.github/workflows/python.yml

@@ -36,12 +36,9 @@ jobs:
           pip install -e ".[dev]"
       - name: "Lint with black"
         uses: psf/black@stable
-      - name: "Lint with flake8"
+      - name: "Lint with ruff"
         run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+          ruff check src tests
       - name: Test with pytest
         run: |
           pip install pytest-cov

pyproject.toml

@@ -2,3 +2,64 @@
 line-length = 100
 target_version = ['py39']
 include = '\.pyi?$'
+
+[tool.ruff]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    # "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "B008",  # do not perform function calls in argument defaults
+    "C901",  # complexity
+]
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["A", "B", "C", "D", "E", "F"]
+unfixable = []
+
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+]
+
+# Same as Black.
+line-length = 100
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+# Assume Python 3.10.
+target-version = "py39"
+
+[tool.ruff.mccabe]
+# Unlike Flake8, default to a complexity level of 10.
+max-complexity = 10
+
+[tool.ruff.isort]
+known-third-party = ["fastapi", "pydantic", "starlette"]
+
+[tool.ruff.per-file-ignores]
+"tests/conftest.py" = ["E402"]

requirements-dev.in

@@ -4,7 +4,8 @@ coverage
 devtools
 factory-boy
 faker
-flake8
 ipython
+ruff
 pytest
 vulture
+typing-extensions==4.4.0

requirements-dev.txt

@@ -1,9 +1,11 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
 #
-#    pip-compile --no-emit-index-url requirements-dev.in
+#    pip-compile requirements-dev.in
 #
+appnope==0.1.3
+    # via ipython
 asttokens==2.2.0
     # via
     #   devtools
@@ -24,6 +26,8 @@ decorator==5.1.1
     # via ipython
 devtools==0.10.0
     # via -r requirements-dev.in
+exceptiongroup==1.1.0
+    # via pytest
 executing==1.2.0
     # via
     #   devtools
@@ -34,8 +38,6 @@ faker==17.0.0
     # via
     #   -r requirements-dev.in
     #   factory-boy
-flake8==6.0.0
-    # via -r requirements-dev.in
 iniconfig==1.1.1
     # via pytest
 ipython==8.10.0
@@ -44,8 +46,6 @@ jedi==0.18.2
     # via ipython
 matplotlib-inline==0.1.6
     # via ipython
-mccabe==0.7.0
-    # via flake8
 mypy-extensions==0.4.3
     # via black
 packaging==21.3
@@ -68,10 +68,6 @@ ptyprocess==0.7.0
     # via pexpect
 pure-eval==0.2.2
     # via stack-data
-pycodestyle==2.10.0
-    # via flake8
-pyflakes==3.0.1
-    # via flake8
 pygments==2.13.0
     # via ipython
 pyparsing==3.0.9
@@ -80,6 +76,8 @@ pytest==7.2.1
     # via -r requirements-dev.in
 python-dateutil==2.8.2
     # via faker
+ruff==0.0.246
+    # via -r requirements-dev.in
 six==1.16.0
     # via
     #   asttokens
@@ -88,10 +86,18 @@ stack-data==0.6.2
     # via ipython
 toml==0.10.2
     # via vulture
+tomli==2.0.1
+    # via
+    #   black
+    #   pytest
 traitlets==5.6.0
     # via
     #   ipython
     #   matplotlib-inline
+typing-extensions==4.4.0
+    # via
+    #   -r requirements-dev.in
+    #   black
 vulture==2.7
     # via -r requirements-dev.in
 wcwidth==0.2.5

setup.cfg

@@ -6,19 +6,6 @@ looponfailroots = src tests
 selenium_driver = chrome
 self-contained-html = true
 
-[flake8]
-# E203 false positive, see https://github.com/PyCQA/pycodestyle/issues/373
-ignore = F999,E203,E266,W403,E501,E128,E124,E402,W503,W504,E731,C901,B007,B306,B009,B010
-exclude = .venv/.git,*/migrations/*,node_modules/*,docs/*
-max-line-length=100
-max-complexity = 18
-select = B,C,E,F,W,T4,B9
-
-# XXX: E501 is ignored, which disables line length checking.
-# Currently, the black formatter doesn't wrap long strings: https://github.com/psf/black/issues/182#issuecomment-385325274
-# We already have a lot of E501's - these are lines black didn't wrap.
-# But rather than append # noqa: E501 to all of them, we just ignore E501 for now.
-
 [bdist_wheel]
 python-tag = py38
 
@@ -29,17 +16,5 @@ source =
     src
     tests
 
-[isort]
-line_length=100
-lines_between_sections=1
-multi_line_output=3
-include_trailing_comma=True
-force_grid_wrap=0
-use_parentheses=True
-known_first_party=dispatch
-default_section=THIRDPARTY
-indent='    '
-skip=setup.py,src/dispatch/models.py
-
 [black]
 line_length=100

src/dispatch/__init__.py

@@ -1,4 +1,3 @@
-from inspect import trace
 import os
 import os.path
 import traceback
@@ -49,12 +48,6 @@
     from dispatch.term.models import Term  # noqa lgtm[py/unused-import]
     from dispatch.ticket.models import Ticket  # noqa lgtm[py/unused-import]
     from dispatch.workflow.models import Workflow  # noqa lgtm[py/unused-import]
-    from dispatch.data.source.environment.models import (
-        SourceEnvironment,
-    )  # noqa lgtm[py/unused-import]
-    from dispatch.data.source.data_format.models import (
-        SourceDataFormat,
-    )  # noqa lgtm[py/unused-import]
     from dispatch.data.source.status.models import SourceStatus  # noqa lgtm[py/unused-import]
     from dispatch.data.source.transport.models import SourceTransport  # noqa lgtm[py/unused-import]
     from dispatch.data.source.type.models import SourceType  # noqa lgtm[py/unused-import]

src/dispatch/case/views.py

@@ -257,4 +257,4 @@ def delete_case(
                     )
                 }
             ],
-        )
+        ) from None

src/dispatch/database/revisions/tenant/versions/2021-07-22_2780d28e4f39.py

@@ -6,7 +6,6 @@
 
 """
 from alembic import op
-import sqlalchemy as sa
 
 
 # revision identifiers, used by Alembic.

src/dispatch/database/revisions/tenant/versions/2022-05-26_5e2bc6083503.py

@@ -7,7 +7,6 @@
 """
 from alembic import op
 import sqlalchemy as sa
-from sqlalchemy.dialects import postgresql
 
 # revision identifiers, used by Alembic.
 revision = "5e2bc6083503"

src/dispatch/database/revisions/tenant/versions/2023-01-25_e23c468440c9.py

@@ -6,8 +6,6 @@
 
 """
 from alembic import op
-import sqlalchemy as sa
-from sqlalchemy.dialects import postgresql
 
 # revision identifiers, used by Alembic.
 revision = "e23c468440c9"

src/dispatch/database/revisions/tenant/versions/2023-01-27_956eb8f8987e.py

@@ -7,7 +7,6 @@
 """
 from alembic import op
 import sqlalchemy as sa
-from sqlalchemy.dialects import postgresql
 
 # revision identifiers, used by Alembic.
 revision = "956eb8f8987e"

src/dispatch/database/service.py

@@ -94,9 +94,11 @@ def __init__(self, filter_spec):
         try:
             filter_spec["field"]
         except KeyError:
-            raise BadFilterFormat("`field` is a mandatory filter attribute.")
+            raise BadFilterFormat("`field` is a mandatory filter attribute.") from None
         except TypeError:
-            raise BadFilterFormat("Filter spec `{}` should be a dictionary.".format(filter_spec))
+            raise BadFilterFormat(
+                "Filter spec `{}` should be a dictionary.".format(filter_spec)
+            ) from None
 
         self.operator = Operator(filter_spec.get("op"))
         self.value = filter_spec.get("value")
@@ -478,11 +480,11 @@ def search_filter_sort_paginate(
                 ErrorWrapper(FieldNotFoundError(msg=str(e)), loc="filter"),
             ],
             model=BaseModel,
-        )
+        ) from None
     except BadFilterFormat as e:
         raise ValidationError(
             [ErrorWrapper(InvalidFilterError(msg=str(e)), loc="filter")], model=BaseModel
-        )
+        ) from None
 
     if items_per_page == -1:
         items_per_page = None

src/dispatch/entity_type/views.py

@@ -46,7 +46,7 @@ def create_entity_type(*, db_session: Session = Depends(get_db), entity_type_in:
         raise ValidationError(
             [ErrorWrapper(ExistsError(msg="A entity with this name already exists."), loc="name")],
             model=EntityTypeCreate,
-        )
+        ) from None
     return entity
 
 
@@ -77,7 +77,7 @@ def update_entity_type(
                 )
             ],
             model=EntityTypeUpdate,
-        )
+        ) from None
     return entity_type
 
 
@@ -108,7 +108,7 @@ def process_entity_type(
                 )
             ],
             model=EntityTypeUpdate,
-        )
+        ) from None
     return entity_type
 
 

src/dispatch/event/models.py

@@ -2,7 +2,6 @@
 from uuid import UUID
 
 from typing import Optional
-from dispatch.models import PrimaryKey
 
 from sqlalchemy import Column, DateTime, ForeignKey, Integer, String
 from sqlalchemy.dialects.postgresql import UUID as SQLAlchemyUUID

src/dispatch/evergreen/scheduled.py

@@ -75,7 +75,7 @@ def create_evergreen_reminder(
         return
 
     # we set the evergreen last reminder at time to now
-    for resource_type, resources in resource_groups.items():
+    for _, resources in resource_groups.items():
         for resource in resources:
             resource.evergreen_last_reminder_at = datetime.utcnow()
 

src/dispatch/incident/scheduled.py

@@ -127,7 +127,7 @@ def daily_report(db_session: SessionLocal, project: Project):
 
     # we create and send an incidents daily report for each notification filter
     for notification_id, search_filter_dict in incidents_notification_filters_mapping.items():
-        for search_filter_id, incidents in search_filter_dict.items():
+        for _search_filter_id, incidents in search_filter_dict.items():
             items_grouped = []
             items_grouped_template = INCIDENT
 

src/dispatch/logging.py

@@ -16,7 +16,7 @@ class LogLevels(DispatchEnum):
 
 def configure_logging():
     log_level = str(LOG_LEVEL).upper()  # cast to string
-    log_levels = [level for level in LogLevels]
+    log_levels = list(LogLevels)
 
     if log_level not in log_levels:
         # we use error as the default log level

src/dispatch/notification/service.py

@@ -3,7 +3,6 @@
 from typing import List, Optional, Type
 
 from dispatch.database.core import Base
-from dispatch.case.models import Case
 from dispatch.models import PrimaryKey
 from dispatch.plugin import service as plugin_service
 from dispatch.project import service as project_service

src/dispatch/organization/views.py

@@ -122,5 +122,5 @@ def update_organization(
                 )
             ],
             model=OrganizationUpdate,
-        )
+        ) from None
     return organization

src/dispatch/plugins/dispatch_atlassian_confluence/docs/plugin.py

@@ -5,7 +5,7 @@
 from typing import List
 
 
-def replace_content(client: Confluence, document_id: str, replacements: List[str]) -> dict():
+def replace_content(client: Confluence, document_id: str, replacements: List[str]) -> {}:
     # read content based on document_id
     current_content = client.get_page_by_id(
         document_id, expand="body.storage", status=None, version=None

src/dispatch/plugins/dispatch_atlassian_confluence/plugin.py

@@ -52,7 +52,7 @@ def __init__(self):
         self.configuration_schema = ConfluenceConfiguration
 
     def create_file(
-        self, drive_id: str, name: str, participants: List[str] = [], file_type: str = "folder"
+        self, drive_id: str, name: str, participants: List[str] = None, file_type: str = "folder"
     ):
         """Creates a new Home page for the incident documents.."""
         try: