Reduce ruff lint exceptions

Author: goncalossilva

pyproject.toml

@@ -68,127 +68,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
+  #"S101", # assert
   "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

sqs_workers/backoff_policies.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/batching.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/context.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/core.py

@@ -33,7 +33,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

sqs_workers/memory_sqs.py

@@ -115,7 +115,7 @@ def send_messages(self, Entries):
     def receive_messages(self, WaitTimeSeconds="0", MaxNumberOfMessages="10", **kwargs):
         """
         Helper function which returns at most max_messages from the
-        queue. Used in an infinite loop inside `get_raw_messages`
+        queue. Used in an infinite loop inside `get_raw_messages`.
         """
         wait_seconds = int(WaitTimeSeconds)
         max_messages = int(MaxNumberOfMessages)
@@ -174,7 +174,7 @@ def delete_messages(self, Entries):
     def change_message_visibility_batch(self, Entries):
         """
         Changes message visibility by looking at in-flight messages, setting
-        a new visible_at, when it will return to the pool of messages
+        a new visible_at, when it will return to the pool of messages.
         """
         found_entries = []
         not_found_entries = []
@@ -210,7 +210,7 @@ def __getitem__(self, item):
 @dataclass(frozen=True)
 class MemoryMessage:
     """
-    A mock class to mimic the AWS message
+    A mock class to mimic the AWS message.
 
     Ref: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/
          services/sqs.html#SQS.Message

sqs_workers/processors.py

@@ -108,7 +108,7 @@ def process_batch(self, messages):
     def copy(self, **kwargs):
         """
         Create a new instance of the processor, optionally updating
-        arguments of the constructor from update_kwargs
+        arguments of the constructor from update_kwargs.
         """
         return replace(self, **kwargs)
 

sqs_workers/queue.py

@@ -60,7 +60,7 @@ def maker(cls, **kwargs):
     def process_queue(
         self, shutdown_policy: ShutdownPolicy = NEVER_SHUTDOWN, wait_second=10
     ):
-        """Run worker to process one queue in the infinite loop"""
+        """Run worker to process one queue in the infinite loop."""
         logger.debug(
             "Start processing queue %s",
             self.name,
@@ -88,7 +88,7 @@ def process_queue(
     def process_batch(self, wait_seconds: int = 0) -> BatchProcessingResult:
         """
         Process a batch of messages from the queue (10 messages at most), return
-        the number of successfully processed messages, and exit
+        the number of successfully processed messages, and exit.
         """
         if self.batching_policy.batching_enabled:
             messages = self.get_raw_messages(
@@ -187,7 +187,7 @@ def process_messages(self, messages: list[Any]) -> bool:
         raise NotImplementedError()
 
     def get_raw_messages(self, wait_seconds: int, max_messages: int = 10) -> list[Any]:
-        """Return raw messages from the queue, addressed by its name"""
+        """Return raw messages from the queue, addressed by its name."""
         queue = self.get_queue()
 
         kwargs = {
@@ -246,7 +246,7 @@ def get_sqs_queue_name(self) -> str:
         """
         Take "high-level" (user-visible) queue name and return SQS
         ("low level") name by simply prefixing it. Used to create namespaces
-        for different environments (development, staging, production, etc)
+        for different environments (development, staging, production, etc).
         """
         return self.env.get_sqs_queue_name(self.name)
 
@@ -265,7 +265,7 @@ class RawQueue(GenericQueue):
 
     def raw_processor(self):
         """
-        Decorator to assign processor to handle jobs from the raw queue
+        Decorator to assign processor to handle jobs from the raw queue.
 
         Usage example:
 
@@ -302,8 +302,7 @@ def add_raw_job(
         deduplication_id: str | None = None,
         group_id: str = DEFAULT_MESSAGE_GROUP_ID,
     ):
-        """Add raw message to the queue"""
-
+        """Add raw message to the queue."""
         kwargs = {
             "MessageBody": message_body,
             "DelaySeconds": delay_seconds,
@@ -353,7 +352,7 @@ def process_message(self, message: Any) -> bool:
 
     def process_messages(self, messages: list[Any]) -> bool:
         """
-        Sends a list of messages to the call handler
+        Sends a list of messages to the call handler.
 
         Return True if processing went successful for all messages in the batch.
         """
@@ -400,7 +399,7 @@ def processor(
     ) -> Callable[[Callable[P, Any]], AsyncTask[P]]:
         """
         Decorator to assign processor to handle jobs with the name job_name
-        from the queue queue_name
+        from the queue queue_name.
 
         Usage example:
 
@@ -439,7 +438,7 @@ def connect_processor(
     ) -> AsyncTask[P]:
         """
         Assign processor (a function) to handle jobs with the name job_name
-        from the queue queue_name
+        from the queue queue_name.
         """
         extra = {
             "queue_name": self.name,
@@ -463,7 +462,7 @@ def connect_processor(
         return AsyncTask(self, job_name, processor)
 
     def get_processor(self, job_name: str) -> Processor | None:
-        """Helper function to return a processor for the queue"""
+        """Helper function to return a processor for the queue."""
         return self.processors.get(job_name)
 
     def open_add_batch(self) -> None:
@@ -581,7 +580,7 @@ def add_job(
     ) -> str | None:
         """
         Add job to the queue. The body of the job will be converted to the text
-        with one of the codecs (by default it's "pickle_compat")
+        with one of the codecs (by default it's "pickle_compat").
         """
         if not _content_type:
             _content_type = self.env.codec
@@ -608,7 +607,7 @@ def add_raw_job(
         deduplication_id,
         group_id: str | None,
     ) -> str | None:
-        """Low-level function to put message to the queue"""
+        """Low-level function to put message to the queue."""
         # if queue name ends with .fifo, then according to the AWS specs,
         # it's a FIFO queue, and requires group_id.
         # Otherwise group_id can be set to None
@@ -654,7 +653,7 @@ def process_message(self, message: Any) -> bool:
 
     def process_messages(self, messages: list[Any]) -> bool:
         """
-        Sends a list of messages to the call handler
+        Sends a list of messages to the call handler.
 
         Return True if processing went successful for all messages in the batch.
         """