chore: migrate lint tool from isort+black to ruff (#35)

* chore: migrate lint tool from isort+black to ruff

* chore: remove unused noqa and use tuple instead of list to improve speed

* chore: remove ruff extend rule SIM

* refactor: add `__all__` to fix F401 issue

Author: waketzheng

Makefile

@@ -1,24 +1,24 @@
 src_dir = pypika_tortoise
 checkfiles = $(src_dir) tests/ conftest.py
-black_opts = -l 100 -t py39
 py_warn = PYTHONDEVMODE=1
 pytest_opts = -n auto --cov=$(src_dir) --cov-append --cov-branch --tb=native -q
 
 up:
 	@poetry update
 
 deps:
-	@poetry install
+	poetry install --all-groups
+
+typehints:
+	mypy $(checkfiles)
+	bandit -c pyproject.toml -r $(checkfiles)
+	twine check dist/*
 
 check: build _check
 _check:
-ifneq ($(shell which black),)
-	black --check $(black_opts) $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
-endif
+	ruff format --check $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
 	ruff check $(checkfiles)
-	bandit -c pyproject.toml -r $(checkfiles)
-	mypy $(checkfiles)
-	twine check dist/*
+	$(MAKE) typehints
 
 test: deps _test
 _test:
@@ -28,16 +28,11 @@ ci: build _check _test
 
 style: deps _style
 _style:
-	isort -src $(checkfiles)
-	black $(black_opts) $(checkfiles)
-
-lint: build
-	isort -src $(checkfiles)
-	black $(black_opts) $(checkfiles)
+	ruff format $(checkfiles)
 	ruff check --fix $(checkfiles)
-	mypy $(checkfiles)
-	bandit -c pyproject.toml -r $(checkfiles)
-	twine check dist/*
+
+lint: build _style
+	$(MAKE) typehints
 
 build: deps
 	poetry build --clean

poetry.lock

@@ -3,3 +3,19 @@
 from .oracle import OracleQuery, OracleQueryBuilder
 from .postgresql import PostgreSQLQuery, PostgreSQLQueryBuilder
 from .sqlite import SQLLiteQuery, SQLLiteQueryBuilder, SQLLiteValueWrapper
+
+__all__ = (
+    "MSSQLQuery",
+    "MSSQLQueryBuilder",
+    "MySQLLoadQueryBuilder",
+    "MySQLQuery",
+    "MySQLQueryBuilder",
+    "MySQLValueWrapper",
+    "OracleQuery",
+    "OracleQueryBuilder",
+    "PostgreSQLQuery",
+    "PostgreSQLQueryBuilder",
+    "SQLLiteQuery",
+    "SQLLiteQueryBuilder",
+    "SQLLiteValueWrapper",
+)

pypika_tortoise/dialects/__init__.py

@@ -149,8 +149,8 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
             return ""
 
         has_joins = bool(self._joins)
-        has_multiple_from_clauses = 1 < len(self._from)
-        has_subquery_from_clause = 0 < len(self._from) and isinstance(self._from[0], QueryBuilder)
+        has_multiple_from_clauses = len(self._from) > 1
+        has_subquery_from_clause = len(self._from) > 0 and isinstance(self._from[0], QueryBuilder)
         has_reference_to_foreign_table = self._foreign_table
         has_update_from = self._update_table and self._from
 
@@ -167,10 +167,7 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
             ),
         )
         if self._update_table:
-            if self._with:
-                querystring = self._with_sql(ctx)
-            else:
-                querystring = ""
+            querystring = self._with_sql(ctx) if self._with else ""
 
             querystring += self._update_sql(ctx)
 

pypika_tortoise/dialects/postgresql.py

@@ -43,8 +43,8 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
             return ""
 
         has_joins = bool(self._joins)
-        has_multiple_from_clauses = 1 < len(self._from)
-        has_subquery_from_clause = 0 < len(self._from) and isinstance(self._from[0], QueryBuilder)
+        has_multiple_from_clauses = len(self._from) > 1
+        has_subquery_from_clause = len(self._from) > 0 and isinstance(self._from[0], QueryBuilder)
         has_reference_to_foreign_table = self._foreign_table
         has_update_from = self._update_table and self._from
 
@@ -60,13 +60,9 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
             ),
         )
         if self._update_table:
-            if self._with:
-                querystring = self._with_sql(ctx)
-            else:
-                querystring = ""
+            querystring = self._with_sql(ctx) if self._with else ""
 
             querystring += self._update_sql(ctx)
-
             querystring += self._set_sql(ctx)
 
             if self._joins:

pypika_tortoise/dialects/sqlite.py

@@ -41,7 +41,7 @@ def distinct(self) -> Self:  # type:ignore[return]
 
 class Count(DistinctOptionFunction):
     def __init__(self, param: Any, alias: str | None = None) -> None:
-        is_star = isinstance(param, str) and "*" == param
+        is_star = isinstance(param, str) and param == "*"
         super().__init__("COUNT", Star() if is_star else param, alias=alias)
 
 

pypika_tortoise/functions.py

@@ -876,9 +876,7 @@ def from_(self, selectable: Selectable | Query | str) -> Self:  # type:ignore[re
         """
 
         self._from.append(
-            Table(selectable)
-            if isinstance(selectable, str)
-            else selectable  # type:ignore[arg-type]
+            Table(selectable) if isinstance(selectable, str) else selectable  # type:ignore[arg-type]
         )
 
         if isinstance(selectable, (QueryBuilder, _SetOperation)) and selectable.alias is None:
@@ -1131,7 +1129,7 @@ def with_totals(self) -> Self:  # type:ignore[return]
     def rollup(  # type:ignore[return]
         self, *terms: list | tuple | set | Term, **kwargs: Any
     ) -> Self:
-        for_mysql = "mysql" == kwargs.get("vendor")
+        for_mysql = kwargs.get("vendor") == "mysql"
 
         if self._mysql_rollup:
             raise AttributeError("'Query' object has no attribute '%s'" % "rollup")
@@ -1151,7 +1149,7 @@ def rollup(  # type:ignore[return]
             self._mysql_rollup = True
             self._groupbys += terms  # type:ignore[arg-type]
 
-        elif 0 < len(self._groupbys) and isinstance(self._groupbys[-1], Rollup):
+        elif len(self._groupbys) > 0 and isinstance(self._groupbys[-1], Rollup):
             # If a rollup was added last, then append the new terms to the previous rollup
             self._groupbys[-1].args += terms
 
@@ -1278,7 +1276,7 @@ def _list_aliases(field_set: Sequence[Field], ctx: SqlContext) -> list[str]:
         return [field.alias or field.get_sql(ctx) for field in field_set]
 
     def _select_field_str(self, term: str) -> None:
-        if 0 == len(self._from):
+        if len(self._from) == 0:
             raise QueryException(f"Cannot select {term}, no FROM table specified.")  # nosec:B608
 
         if term == "*":
@@ -1399,8 +1397,8 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
             return ""
 
         has_joins = bool(self._joins)
-        has_multiple_from_clauses = 1 < len(self._from)
-        has_subquery_from_clause = 0 < len(self._from) and isinstance(self._from[0], QueryBuilder)
+        has_multiple_from_clauses = len(self._from) > 1
+        has_subquery_from_clause = len(self._from) > 0 and isinstance(self._from[0], QueryBuilder)
         has_reference_to_foreign_table = self._foreign_table
         has_update_from = self._update_table and self._from
 
@@ -1417,11 +1415,7 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
         )
 
         if self._update_table:
-            if self._with:
-                querystring = self._with_sql(ctx)
-            else:
-                querystring = ""
-
+            querystring = self._with_sql(ctx) if self._with else ""
             querystring += self._update_sql(ctx)
 
             if self._joins:
@@ -1441,10 +1435,7 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
             querystring = self._delete_sql(ctx)
 
         elif not self._select_into and self._insert_table:
-            if self._with:
-                querystring = self._with_sql(ctx)
-            else:
-                querystring = ""
+            querystring = self._with_sql(ctx) if self._with else ""
 
             if self._replace:
                 querystring += self._replace_sql(ctx)
@@ -1464,11 +1455,7 @@ def get_sql(self, ctx: SqlContext | None = None) -> str:
                 querystring += " " + self._select_sql(ctx)
 
         else:
-            if self._with:
-                querystring = self._with_sql(ctx)
-            else:
-                querystring = ""
-
+            querystring = self._with_sql(ctx) if self._with else ""
             querystring += self._select_sql(ctx)
 
             if self._insert_table:
@@ -1568,7 +1555,7 @@ def _for_update_sql(self, ctx: SqlContext, lock_strength="UPDATE") -> str:
             for_update = f" FOR {lock_strength}"
             if self._for_update_of:
                 for_update += (
-                    f' OF {", ".join([Table(item).get_sql(ctx) for item in self._for_update_of])}'
+                    f" OF {', '.join([Table(item).get_sql(ctx) for item in self._for_update_of])}"
                 )
             if self._for_update_nowait:
                 for_update += " NOWAIT"
@@ -1761,8 +1748,9 @@ def __init__(
     def on(self, criterion: Criterion | None, collate: str | None = None) -> QueryBuilder:
         if criterion is None:
             raise JoinException(
-                "Parameter 'criterion' is required for a "
-                "{type} JOIN but was not supplied.".format(type=self.type_label)
+                "Parameter 'criterion' is required for a {type} JOIN but was not supplied.".format(
+                    type=self.type_label
+                )
             )
 
         self.query.do_join(JoinOn(self.item, self.how, criterion, collate))  # type:ignore[arg-type]
@@ -1771,8 +1759,9 @@ def on(self, criterion: Criterion | None, collate: str | None = None) -> QueryBu
     def on_field(self, *fields: Any) -> QueryBuilder:
         if not fields:
             raise JoinException(
-                "Parameter 'fields' is required for a "
-                "{type} JOIN but was not supplied.".format(type=self.type_label)
+                "Parameter 'fields' is required for a {type} JOIN but was not supplied.".format(
+                    type=self.type_label
+                )
             )
 
         criterion = None
@@ -2181,7 +2170,8 @@ def _unique_key_clauses(self, ctx: SqlContext) -> list[str]:
 
     def _primary_key_clause(self, ctx: SqlContext) -> str:
         columns = ",".join(
-            column.get_name_sql(ctx) for column in self._primary_key  # type:ignore[union-attr]
+            column.get_name_sql(ctx)
+            for column in self._primary_key  # type:ignore[union-attr]
         )
         return f"PRIMARY KEY ({columns})"
 

pypika_tortoise/queries.py

@@ -42,13 +42,13 @@ def ignore_copy(func: Callable[[T_Self, str], T_Retval]) -> Callable[[T_Self, st
     """
 
     def _getattr(self: T_Self, name: str) -> T_Retval:
-        if name in [
+        if name in (
             "__copy__",
             "__deepcopy__",
             "__getstate__",
             "__setstate__",
             "__getnewargs__",
-        ]:
+        ):
             raise AttributeError(
                 "'%s' object has no attribute '%s'" % (self.__class__.__name__, name)
             )

pypika_tortoise/utils.py

@@ -22,23 +22,19 @@ packages = [
 [tool.poetry.group.dev.dependencies]
 ruff = "*"
 mypy = "*"
-isort = "*"
-black = "*"
-pytest = "*"
 bandit = "*"
-pytest-xdist = "*"
-pytest-cov = "*"
 twine = "*"
 typing-extensions = {version = "*", python = "<3.11"}
 
+[tool.poetry.group.test.dependencies]
+pytest = "*"
+pytest-cov = "*"
+pytest-xdist = "*"
+
 [build-system]
 requires = ["poetry-core>=2.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.black]
-line-length = 100
-target-version = ['py39', 'py310', 'py311', 'py312', 'py313']
-
 [tool.mypy]
 pretty = true
 python_version = "3.9"
@@ -49,6 +45,7 @@ line-length = 100
 
 [tool.ruff.lint]
 extend-select = [
+    "I",      # https://docs.astral.sh/ruff/rules/#isort-i
     "FA",     # https://docs.astral.sh/ruff/rules/#flake8-future-annotations-fa
     "UP",     # https://docs.astral.sh/ruff/rules/#pyupgrade-up
     "RUF100", # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
@@ -57,9 +54,6 @@ ignore = ["UP031", "UP032"] # https://docs.astral.sh/ruff/rules/printf-string-fo
 
 [tool.ruff.lint.per-file-ignores]
 'pypika_tortoise/__init__.py' = ['F401']
-'pypika_tortoise/dialects/__init__.py' = ['F401']
-'tests/test_functions.py' = ['UP034']
-'tests/dialects/test_postgresql.py' = ['RUF100']
 
 [tool.bandit]
 exclude_dirs = ["tests", "conftest.py"]

pyproject.toml

@@ -147,7 +147,7 @@ def test_json_contains_for_field(self):
         )
 
         self.assertEqual(
-            "SELECT * " 'FROM "abc" ' 'WHERE "json"@>\'{"dates":"2018-07-10 - 2018-07-17"}\'',
+            'SELECT * FROM "abc" WHERE "json"@>\'{"dates":"2018-07-10 - 2018-07-17"}\'',
             str(q),
         )
 
@@ -200,7 +200,7 @@ def test_json_has_key(self):
         q = (
             PostgreSQLQuery.from_(self.table_abc)
             .select("*")
-            .where(self.table_abc.json.has_key("dates"))  # noqa: W601
+            .where(self.table_abc.json.has_key("dates"))
         )
 
         self.assertEqual('SELECT * FROM "abc" WHERE "json"?\'dates\'', str(q))