Merge pull request #125 from Doist/goncalossilva/simplify-ruff

Author: goncalossilva

.pre-commit-config.yaml

@@ -1,6 +1,3 @@
-default_language_version:
-  python: python3.12
-
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0

poetry.lock

@@ -20,7 +20,7 @@ readme = "README.md"
 exclude = ['tests/']
 
 [tool.poetry.dependencies]
-python = "^3.9,<3.14"
+python = ">=3.9,<3.14"
 boto3 = "^1.27.33"
 
 [tool.poetry.group.dev.dependencies]
@@ -42,19 +42,40 @@ extend-exclude = ["env", "runtime"]
 
 [tool.ruff.lint]
 select = [
+  "A",     # flake8-builtins
   "ASYNC", # flake8-async
+  "B",     # flake8-bugbear
   "C4",    # flake8-comprehensions
   "D",     # pydocstyle,
+  "DTZ",   # flake8-datetimez,
   "E",     # pycodestyle errors
   "W",     # pycodestyle warnings
-  "W",     # pycodestyle
   "F",     # pyflakes
   "I",     # isort
   "PL",    # pylint
   "RUF",   # ruff
   "S",     # flake8-bandit
+  "T20",   # flake8-print
   "SIM",   # flake8-simplify
   "UP",    # pyupgrade
+  "TC",    # flake8-type-checking
+  "BLE",   # flake8-blind-except
+  "FA",    # flake8-future-annotations
+  "FIX",   # flake8-fixme
+  "ICN",   # flake8-import-conventions
+  "LOG",   # flake8-logging
+  "G",     # flake8-logging-format
+  "RET",   # flake8-logging-return
+  "ISC",   # flake8-implicit-str-concat
+  "INP",   # flake8-no-pep420
+  "PIE",   # flake8-pie
+  "PT",    # flake8-pytest-style
+  "TID",   # flake8-tidy-imports
+  "PTH",   # flake8-user-pathlib
+  "PERF",  # perflint
+  "FURB",  # refurb
+  "PGH",   # pygrep-hooks
+  "PYI",   # flake8-pyi
 ]
 
 ignore = [
@@ -68,127 +89,22 @@ ignore = [
   "D105",
   "D107",
   # These need to be fixed.
-  "D202",
   "D205",
   "D400",
   "D401",
 
   ## E / W - pycodestyle ##
   "E501", # line too long
-  "E203", # whitespace-before-punctuation
-  "E741", # ambiguous variable name
 
-  ## PL - pylint ##
-  # Commented-out rules are rules that we disable in pylint but are not supported by ruff yet.
-
-  # Import order issues
-  # "PLC0411",  # wrong-import-order
-  # "PLC0412",  # wrong-import-position
-  "PLC0414", # ungrouped-imports
-
-  # Documentation issues
-  # "C0114",  # missing-module-docstring
-
-  # Complexity issues
-  # "PLR0904",  # too-many-public-methods
-  # "PLC0302",  # too-many-lines
-  # "PLR1702",  # too-many-nested-blocks
-  # "PLR0902",  # too-many-instance-attributes
-  "PLR0911", # too-many-return-statements
-  "PLR0915", # too-many-statements
-  "PLR0912", # too-many-branches
-  # "PLR0903",  # too-few-public-methods
-  # "PLR0914",  # too-many-locals
-  # "PLC0301",  # line-too-long
+  # ## PL - pylint ##
   "PLR0913", # too-many-arguments
   "PLR2004", # magic-value-comparison
-  "PLR5501", # collapsible-else-if
   "PLW0603", # global-statement
-  "PLW2901", # redefined-loop-name
-  "PLC1901", # compare-to-empty-string
-
-  ## RUF - ruff ##
-  "RUF001", # ambiguous-unicode-character-string
-  "RUF002", # ambiguous-unicode-character-docstring
-  "RUF003", # ambiguous-unicode-character-comment
-  "RUF012", # mutable-class-default
-
-  # Enable when Poetry supports PEP 621 and we migrate our confguration to it.
-  # See: https://github.com/python-poetry/poetry-core/pull/567
-  "RUF200",
 
   "S101", # assert
-  "S104", # hardcoded-bind-all-interfaces
-  "S105", # hardcoded-password-string
-  "S106", # hardcoded-password-func-arg
-  "S107", # hardcoded-password-default
-  "S110", # try-except-pass
   "S301", # suspicious-pickle-usage
-  "S303", # suspicious-insecure-hash-usage
-  "S310", # suspicious-url-open-usage
   "S311", # suspicious-non-cryptographic-random-usage
-  "S324", # hashlib-insecure-hash-function
-  "S603", # subprocess-without-shell-equals-true
-  "S607", # start-process-with-partial-path
-  "S608", # hardcoded-sql-expression
-
-  ## SIM - flake8-simplify ##
-  "SIM102", # collapsible-if
-  "SIM105", # suppressible-exception
-  "SIM108", # if-else-block-instead-of-if-exp
-  "SIM114", # if-with-same-arms
-  "SIM116", # if-else-block-instead-of-dict-lookup
-  "SIM117", # multiple-with-statements
-
-  # Enable when the rule is out of preview and false-positives are handled.
-  # See: https://docs.astral.sh/ruff/rules/in-dict-keys/
-  "SIM118", # in-dict-keys
 ]
 
-[tool.ruff.lint.per-file-ignores]
-# These files have only a bunch of imports in them to force code loading.
-"todoist/workers/todoist_handlers.py" = ["F401"]
-"todoist/signals/signal_handlers.py" = ["F401"]
-"todoist/workers/scripts_handlers.py" = ["F401"]
-"scripts/**" = ["S101"]                          # Allow assert statement in scripts.
-"tests/**" = ["S101"]                            # Allow assert statement in tests.
-
-# We allow module-level imports to be not at the top of scripts, cron,
-# and configs because we initialize Todoist environment there
-"todoist/*/scripts/*.py" = ["E402"]
-"todoist/*/cron/*.py" = ["E402"]
-"scripts/*.py" = ["E402"]
-"configs/*.py" = ["E402"]
-
-# To import all fixtures from other conftests.
-"conftest.py" = ["F401", "F403"]
-# To import select fixtures from non-local conftests.
-# Importing and using the fixture makes it be shadowed.
-"test_*.py" = ["F401", "F811"]
-
-"tests/minimal/conftest.py" = ["E402", "F401", "F403"]
-
-[tool.ruff.lint.isort]
-section-order = [
-  "future",
-  "standard-library",
-  "third-party",
-  "parts",
-  "first-party",
-  "td-models",
-  "td-apps",
-  "local-folder",
-]
-
-[tool.ruff.lint.isort.sections]
-"parts" = ["parts"]
-"td-models" = ["todoist.models"]
-"td-apps" = ["todoist.apps"]
-
 [tool.ruff.lint.pydocstyle]
 convention = "pep257"
-
-[tool.ruff.lint.pyupgrade]
-# Required by tools like Pydantic that use type information at runtime.
-# https://github.com/asottile/pyupgrade/issues/622#issuecomment-1088766572
-keep-runtime-typing = true

pyproject.toml

@@ -1,14 +1,12 @@
 from __future__ import annotations
 
-from collections.abc import Generator
 from contextlib import contextmanager
 from typing import (
     TYPE_CHECKING,
     Any,
     Callable,
     Generic,
     NoReturn,
-    Optional,
     TypedDict,
 )
 
@@ -17,6 +15,8 @@
 from sqs_workers.utils import bind_arguments
 
 if TYPE_CHECKING:
+    from collections.abc import Generator
+
     from sqs_workers.queue import JobQueue
 
 
@@ -64,22 +64,21 @@ def run(self, *args: P.args, **kwargs: P.kwargs) -> Any:
                 raise TypeError("Must use keyword arguments only for batch read queues")
             kwargs = bind_arguments(self.processor, [[kwargs]], {})
             return self.processor(**kwargs)  # type:ignore[call-arg]
-        else:
-            kwargs = bind_arguments(self.processor, args, kwargs)
-            return self.processor(**kwargs)  # type:ignore[call-arg]
+        kwargs = bind_arguments(self.processor, args, kwargs)
+        return self.processor(**kwargs)  # type:ignore[call-arg]
 
     @contextmanager
     def batch(self) -> Generator[None, None, None]:
         """Context manager to add jobs in batch."""
         with self.queue.add_batch():
             yield
 
-    def delay(self, *args: P.args, **kwargs: P.kwargs) -> Optional[str]:
+    def delay(self, *args: P.args, **kwargs: P.kwargs) -> str | None:
         """Run the task asynchronously."""
-        _content_type = kwargs.pop("_content_type", self.queue.env.codec)  # type: ignore
-        _delay_seconds = kwargs.pop("_delay_seconds", None)  # type: ignore
-        _deduplication_id = kwargs.pop("_deduplication_id", None)  # type: ignore
-        _group_id = kwargs.pop("_group_id", None)  # type: ignore
+        _content_type = kwargs.pop("_content_type", self.queue.env.codec)
+        _delay_seconds = kwargs.pop("_delay_seconds", None)
+        _deduplication_id = kwargs.pop("_deduplication_id", None)
+        _group_id = kwargs.pop("_group_id", None)
 
         if self.queue.batching_policy.batching_enabled:
             if len(args) > 0:
@@ -89,10 +88,10 @@ def delay(self, *args: P.args, **kwargs: P.kwargs) -> Optional[str]:
 
         return self.queue.add_job(
             self.job_name,
-            _content_type=_content_type,  # type: ignore
-            _delay_seconds=_delay_seconds,  # type: ignore
+            _content_type=_content_type,  # type: ignore[arg-type]
+            _delay_seconds=_delay_seconds,  # type: ignore[arg-type]
             _deduplication_id=_deduplication_id,
-            _group_id=_group_id,  # type: ignore
+            _group_id=_group_id,  # type: ignore[arg-type]
             **kwargs,
         )
 

sqs_workers/async_task.py

@@ -9,7 +9,7 @@ def get_visibility_timeout(self, message):
 class ConstantBackoff(BackoffPolicy):
     """
     Backoff policy which always returns the message back to the queue
-    immediately on failure
+    immediately on failure.
     """
 
     def __init__(self, backoff_value: float = 0):
@@ -22,7 +22,7 @@ def get_visibility_timeout(self, message) -> float:
 class ExponentialBackoff(BackoffPolicy):
     """
     Backoff policy which keeps the message hidden from the queue
-    with an exponential backoff
+    with an exponential backoff.
     """
 
     def __init__(

sqs_workers/backoff_policies.py

@@ -12,19 +12,19 @@ class BatchingConfiguration(ABC):
     def batching_enabled(self) -> bool:
         """
         If false, messages are sent 1 by 1 to the call handler
-        If true, messages are sent as a list to the call handler
+        If true, messages are sent as a list to the call handler.
         """
         ...
 
     @property
     @abstractmethod
     def batch_size(self) -> int:
-        """Number of messages to process at once if batching_enabled"""
+        """Number of messages to process at once if batching_enabled."""
         ...
 
 
 class NoBatching(BatchingConfiguration):
-    """Configures the processor to send messages 1 by 1 to the call handler"""
+    """Configures the processor to send messages 1 by 1 to the call handler."""
 
     @property
     def batching_enabled(self) -> bool:
@@ -36,7 +36,7 @@ def batch_size(self) -> int:
 
 
 class BatchMessages(BatchingConfiguration):
-    """Configures the processor to send a list of messages to the call handler"""
+    """Configures the processor to send a list of messages to the call handler."""
 
     def __init__(self, batch_size: int):
         self.number_of_messages = batch_size

sqs_workers/batching.py

@@ -42,8 +42,7 @@ def get_instance(self, item, **kwargs):
         value = self[item]
         if isinstance(value, dict):
             return instantiate_from_dict(value, maker_key=self.maker_key, **kwargs)
-        else:
-            return instantiate_from_string(value, **kwargs)
+        return instantiate_from_string(value, **kwargs)
 
     def make_child(self, options=None):
         if options is None:

sqs_workers/config.py

@@ -34,40 +34,40 @@ def hello_world(username=None, context=None):
 
     @classmethod
     def from_dict(cls, kwargs):
-        """Create context from the dict"""
+        """Create context from the dict."""
         return cls(**kwargs)
 
     def __init__(self, **kwargs):
-        """Create a new context and populate it with keys and values from kwargs"""
+        """Create a new context and populate it with keys and values from kwargs."""
         self._context = {}
         self.set(**kwargs)
 
     def set(self, **kwargs):
-        """Clean up current context and replace it with values from kwargs"""
+        """Clean up current context and replace it with values from kwargs."""
         self._context = kwargs.copy()
 
     def update(self, **kwargs):
-        """Extend current context with values from kwargs"""
+        """Extend current context with values from kwargs."""
         self._context.update(kwargs)
 
     def clear(self):
-        """Remove all values from the context"""
+        """Remove all values from the context."""
         self._context.clear()
 
     def to_dict(self):
-        """Convert context to dictionary"""
+        """Convert context to dictionary."""
         return self._context.copy()
 
     def get(self, key, default=None):
-        """Get value by key from the context"""
+        """Get value by key from the context."""
         return self._context.get(key, default)
 
     def __getitem__(self, item):
-        """Dict API emulation. Get value by key from the context"""
+        """Dict API emulation. Get value by key from the context."""
         return self._context[item]
 
     def __setitem__(self, key, value):
-        """Dict API emulation. Set value by key"""
+        """Dict API emulation. Set value by key."""
         self._context[key] = value
 
     @contextmanager

sqs_workers/context.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import json
 import logging
-from typing import Any, Optional
+from typing import Any
 
 logger = logging.getLogger(__name__)
 
@@ -33,7 +35,7 @@ def __repr__(self) -> str:
 
 class RedrivePolicy:
     """
-    Redrive Policy for SQS queues
+    Redrive Policy for SQS queues.
 
     See for more details:
     https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
@@ -58,6 +60,6 @@ def __json__(self) -> str:
         )
 
 
-def get_job_name(message) -> Optional[str]:
+def get_job_name(message) -> str | None:
     attrs = message.message_attributes or {}
     return (attrs.get("JobName") or {}).get("StringValue")