Merge pull request #339 from ClearcodeHQ/ruff

Replace pydocstyle and pycodestyle with ruff - closes #285

.github/workflows/linters.yml

@@ -13,5 +13,4 @@ jobs:
       pipenv-install-options: "--skip-lock"
       mypy: true
       black: true
-      pycodestyle: true
-      pydocstyle: true
+      ruff: true

Pipfile

@@ -14,12 +14,11 @@ types-requests = "==2.31.0.9"
 
 [dev-packages]
 towncrier = "==23.6.0"
-pydocstyle = {version = "==6.3.0", extras = ["toml"]}
-pycodestyle = "==2.11.1"
 mypy = "==1.6.0"
 black = "==23.9.1"
 pytest = "==7.4.2"
 pytest-cov = "==4.1.0"
 tbump = "==6.11.0"
 sphinx = "==7.2.6"
 sphinx-jsonschema = "==1.19.1"
+ruff = "==0.0.292"

docs/source/conf.py

@@ -15,10 +15,8 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
 from pathlib import Path
-from typing import List, Dict
-
+from typing import Dict, List
 
 p = Path(os.getcwd())
 sys.path.append(str(p.parent.parent))

jira_timemachine/__init__.py

@@ -7,19 +7,19 @@
 
 """Module for synchronization of Jira worklogs between different instances."""
 
-import re
 import itertools
-from datetime import date, timedelta
+import re
 from dataclasses import dataclass
-from typing import Iterator, Dict, IO, Optional, Tuple, Union
+from datetime import date, timedelta
+from typing import IO, Dict, Iterator, Optional, Tuple, Union
 
-import click
 import arrow
-from jira import JIRA
+import click
 import jira
-from jira.client import ResultList
-from pydantic import BaseModel, HttpUrl, Field, ValidationError
 import requests
+from jira import JIRA
+from jira.client import ResultList
+from pydantic import BaseModel, Field, HttpUrl, ValidationError
 from requests import HTTPError
 
 __version__ = "1.0.1"
@@ -98,8 +98,7 @@ def to_tempo(self) -> dict:
 
 
 class TempoClient:
-    """
-    A client for Tempo Cloud APIs.
+    """A client for Tempo Cloud APIs.
 
     See <https://tempo-io.github.io/tempo-api-docs/> for the API documentation.
     """
@@ -111,8 +110,7 @@ def __init__(self, tempo_token: str, account_id: str) -> None:
         self.session.headers.update({"Authorization": "Bearer %s" % tempo_token})
 
     def get_worklogs(self, from_date: date, single_user: bool = True) -> Iterator[Worklog]:
-        """
-        Return all recent worklogs for the specified user.
+        """Return all recent worklogs for the specified user.
 
         :returns: yields Worklog instances
         """
@@ -156,8 +154,7 @@ def get_worklogs(self, from_date: date, single_user: bool = True) -> Iterator[Wo
             url = response_data["metadata"].get("next")
 
     def update_worklog(self, worklog: Worklog) -> None:
-        """
-        Update the specified worklog.
+        """Update the specified worklog.
 
         :param worklog: updated worklog data
         """
@@ -171,8 +168,7 @@ def update_worklog(self, worklog: Worklog) -> None:
             raise
 
     def post_worklog(self, worklog: Worklog) -> None:
-        """
-        Upload a new worklog.
+        """Upload a new worklog.
 
         :param worklog: new worklog data
         """
@@ -223,8 +219,7 @@ def _issues(self, query: str) -> Iterator[jira.Issue]:
                 return
 
     def get_worklogs(self, from_date: date, single_user: bool = True) -> Iterator[Worklog]:
-        """
-        Return all recent worklogs for the specified user.
+        """Return all recent worklogs for the specified user.
 
         :returns: yields Worklog instances
         """
@@ -258,8 +253,7 @@ def get_client(config: SourceJiraConfig) -> Union[TempoClient, JIRAClient]:
 
 
 def get_worklogs(config: SourceJiraConfig, since: arrow.Arrow, all_users: bool = False) -> Iterator[Worklog]:
-    """
-    Yield user's recent worklogs.
+    """Yield user's recent worklogs.
 
     :param config: JIRA configuration
     :param since: earliest start time of yielded worklogs
@@ -276,8 +270,7 @@ def get_worklogs(config: SourceJiraConfig, since: arrow.Arrow, all_users: bool =
 
 
 def format_time(seconds: int) -> str:
-    """
-    Return *seconds* in a human-readable format (e.g. 25h 15m 45s).
+    """Return *seconds* in a human-readable format (e.g. 25h 15m 45s).
 
     Unlike `timedelta`, we don't aggregate it into days: it's not useful when reporting logged work hours.
     """
@@ -298,8 +291,7 @@ def format_time(seconds: int) -> str:
 
 
 def match_worklog(source_worklogs: Dict[int, Worklog], worklog: Worklog) -> Optional[Worklog]:
-    """
-    Return a matching source worklog for the given destination worklog.
+    """Return a matching source worklog for the given destination worklog.
 
     :param source_worklogs: a mapping from source JIRA worklog ID to `Worklog` instance
     :param worklog: destination JIRA worklog

newsfragments/285.misc.rst

@@ -0,0 +1 @@
+Replace pydocstyle and pycodestyle with ruff

pyproject.toml

@@ -67,6 +67,17 @@ line-length = 120
 target-version = ['py310']
 include = '.*\.pyi?$'
 
+[tool.ruff]
+# Decrease the maximum line length to 79 characters.
+line-length = 120
+select = [
+    "E",   # pycodestyle
+    "F",   # pyflakes
+    "I",   # isort
+    "D",   # pydocstyle
+]
+
+
 [tool.mypy]
 check_untyped_defs = true
 mypy_path = "src"

tests/test_unit.py

@@ -2,15 +2,15 @@
 
 from datetime import date
 from io import StringIO
-from unittest.mock import patch, call, Mock
+from unittest.mock import Mock, call, patch
 
 import arrow
 import click
 import pytest
-from pydantic import HttpUrl, parse_obj_as, TypeAdapter
+from pydantic import HttpUrl, TypeAdapter
 from pydantic_core import Url
 
-from jira_timemachine import Worklog, get_worklogs, format_time, match_worklog, SourceJiraConfig, get_config
+from jira_timemachine import SourceJiraConfig, Worklog, format_time, get_config, get_worklogs, match_worklog
 
 
 def test_worklog_to_tempo():