Add github actions

Author: insani7y

.github/workflow/lint.yml

@@ -0,0 +1,27 @@
+name: Lint and Type Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint-and-typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.0
+        with:
+          extra_args: --all-files --hook-stage manual

.github/workflow/publish.yml

@@ -0,0 +1,26 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.cache/poetry
+          key: publish-${{ hashFiles('pyproject.toml') }}
+      - run: pip install -U poetry
+      - uses: extractions/setup-just@v2
+      - run: just install
+      - run: poetry version ${{ github.event.release.tag_name }}
+      - run: poetry publish --build --username __token__ --password ${{ secrets.GITHUB_TOKEN }}

.github/workflow/test.yml

@@ -0,0 +1,42 @@
+name: Test and Coverage
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: ${{matrix.os}}-${{matrix.python-version}}
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2.1.0
+        with:
+          poetry-version: "1.8.3"
+      - name: Install dependencies with Poetry
+        run: |
+          poetry config virtualenvs.create false
+          poetry install --all-extras --with dev
+      - name: Run tests with coverage
+        run: |
+          pytest . --cov=. --cov-report xml -n 4
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-${{ matrix.python-version }}

.pre-commit-config.yaml

@@ -1,29 +1,17 @@
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.1.0
-    hooks:
-      - id: trailing-whitespace
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        name: isort
-        pass_filenames: false
-        always_run: true
-        args: ["./"]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+    rev: v1.10.1
     hooks:
       - id: mypy
         name: mypy
         always_run: true
-        pass_filenames: false
-        args: ["./"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.291
+    rev: v0.5.0
     hooks:
       - id: ruff
-        name: ruff check
-        pass_filenames: false
+        name: ruff-check
+        always_run: true
+        args: [--fix]
+      - id: ruff-format
+        name: ruff-format
         always_run: true
-        args: ["./", "--fix"]

psqlpy_piccolo/__pycache__/engine.cpython-312.pyc

@@ -1,5 +1,4 @@
 from __future__ import annotations
-
 import contextvars
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, Generator, Mapping, Sequence
@@ -13,6 +12,7 @@
 from psqlpy.exceptions import RustPSQLDriverPyBaseError
 from typing_extensions import Self
 
+
 if TYPE_CHECKING:
     import types
 
@@ -88,7 +88,7 @@ async def __aexit__(
 
 
 class Atomic:
-    """This is useful if you want to build up a transaction programmatically.
+    """Useful if you want to build up a transaction programmatically.
 
     Usage::
 
@@ -205,8 +205,7 @@ def __init__(self: Self, engine: PSQLPyEngine, allow_nested: bool = True) -> Non
                 self._parent = current_transaction
             else:
                 raise TransactionError(
-                    "A transaction is already active - nested transactions "
-                    "aren't allowed.",
+                    "A transaction is already active - nested transactions aren't allowed.",
                 )
 
     async def __aenter__(self: Self) -> Self:
@@ -296,8 +295,7 @@ async def savepoint(self: Self, name: str | None = None) -> Savepoint:
 
 
 class PSQLPyEngine(Engine[PostgresTransaction]):
-    """
-    Engine for PostgreSQL.
+    """Engine for PostgreSQL.
 
     ### Params:
     - `config`:
@@ -334,16 +332,12 @@ class PSQLPyEngine(Engine[PostgresTransaction]):
         to a ``PSQLPyEngine`` instance. For example::
 
             DB = PSQLPyEngine(
-                config={'database': 'main_db'},
+                config={"database": "main_db"},
                 extra_nodes={
-                    'read_replica_1': PSQLPyEngine(
-                        config={
-                            'database': 'main_db',
-                            host: 'read_replicate.my_db.com'
-                        },
-                        extensions=()
+                    "read_replica_1": PSQLPyEngine(
+                        config={"database": "main_db", host: "read_replicate.my_db.com"}, extensions=()
                     )
-                }
+                },
             )
 
         Note how we set ``extensions=()``, because it's a read only database.
@@ -358,7 +352,7 @@ class PSQLPyEngine(Engine[PostgresTransaction]):
     engine_type = "postgres"
     min_version_number = 10
 
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self: Self,
         config: dict[str, Any],
         extensions: Sequence[str] = ("uuid-ossp",),
@@ -403,16 +397,12 @@ def __init__(
             to a ``PSQLPyEngine`` instance. For example::
 
                 DB = PSQLPyEngine(
-                    config={'database': 'main_db'},
+                    config={"database": "main_db"},
                     extra_nodes={
-                        'read_replica_1': PSQLPyEngine(
-                            config={
-                                'database': 'main_db',
-                                host: 'read_replicate.my_db.com'
-                            },
-                            extensions=()
+                        "read_replica_1": PSQLPyEngine(
+                            config={"database": "main_db", host: "read_replicate.my_db.com"}, extensions=()
                         )
-                    }
+                    },
                 )
 
             Note how we set ``extensions=()``, because it's a read only database.
@@ -507,17 +497,15 @@ async def start_connnection_pool(
         - `kwargs`: configuration parameters for `ConnectionPool` from PSQLPy.
         """
         colored_warning(
-            "`start_connnection_pool` is a typo - please change it to "
-            "`start_connection_pool`.",
+            "`start_connnection_pool` is a typo - please change it to `start_connection_pool`.",
             category=DeprecationWarning,
         )
         return await self.start_connection_pool()
 
     async def close_connnection_pool(self: Self, **_kwargs: dict[str, Any]) -> None:
         """Close connection pool."""
         colored_warning(
-            "`close_connnection_pool` is a typo - please change it to "
-            "`close_connection_pool`.",
+            "`close_connnection_pool` is a typo - please change it to `close_connection_pool`.",
             category=DeprecationWarning,
         )
         return await self.close_connection_pool()
@@ -533,8 +521,7 @@ async def start_connection_pool(self: Self, **kwargs: dict[str, Any]) -> None:
         """
         if self.pool:
             colored_warning(
-                "A pool already exists - close it first if you want to create "
-                "a new pool.",
+                "A pool already exists - close it first if you want to create a new pool.",
             )
         else:
             config = dict(self.config)
@@ -669,7 +656,6 @@ async def run_querystring(
 
         if self.log_queries:
             self.print_query(query_id=query_id, query=querystring.__str__())
-        print(querystring)
         # If running inside a transaction:
         current_transaction = self.current_transaction.get()
         if current_transaction:

psqlpy_piccolo/engine.py

@@ -7,7 +7,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-piccolo = {version = "^1.14.0", extras = ["postgres"]}
+piccolo = { version = "^1.14.0", extras = ["postgres"] }
 psqlpy = "^0.7.4"
 typing-extensions = "^4.12.2"
 
@@ -49,52 +49,44 @@ warn_return_any = false
 warn_unused_ignores = false
 
 [tool.ruff]
-# List of enabled rulsets.
-# See https://docs.astral.sh/ruff/rules/ for more information.
-select = [
-    "E",   # Error
-    "F",   # Pyflakes
-    "W",   # Pycodestyle
-    "C90", # McCabe complexity
-    "N",   # pep8-naming
-    "D",   # Pydocstyle
-    "ANN", # Pytype annotations
-    "S",   # Bandit
-    "B",   # Bugbear
-    "COM", # Commas
-    "C4",  # Comprehensions
-    "ISC", # Implicit string concat
-    "PIE", # Unnecessary code
-    "T20", # Catch prints
-    "PYI", # validate pyi files
-    "Q",   # Checks for quotes
-    "RSE", # Checks raise statements
-    "RET", # Checks return statements
-    "SLF", # Self checks
-    "SIM", # Simplificator
-    "PTH", # Pathlib checks
-    "ERA", # Checks for commented out code
-    "PL",  # PyLint checks
-    "RUF", # Specific to Ruff checks
-]
+target-version = "py38"
+line-length = 120
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = ["ALL"]
 ignore = [
-    "D105",    # Missing docstring in magic method
-    "D107",    # Missing docstring in __init__
-    "D211",    # No blank lines allowed before class docstring
-    "D212",    # Multi-line docstring summary should start at the first line
-    "D401",    # First line should be in imperative mood
-    "D104",    # Missing docstring in public package
-    "D100",    # Missing docstring in public module
-    "ANN102",  # Missing type annotation for self in method
-    "ANN101",  # Missing type annotation for argument
-    "ANN401",  # typing.Any are disallowed in `**kwargs
-    "PLR0913", # Too many arguments for function call
-    "D106",    # Missing docstring in public nested class
+    "EM",
+    "FBT",
+    "FIX002",
+    "TRY003",
+    "TD003",
+    "D1",
+    "D106",
+    "D203",
+    "D213",
+    "G004",
+    "FA",
+    "ANN101",
+    "ANN102",
+    "COM812",
+    "ISC001",
 ]
-exclude = [".venv/"]
-mccabe = { max-complexity = 10 }
-line-length = 89
 
-[tool.ruff.pydocstyle]
-convention = "pep257"
-ignore-decorators = ["typing.overload"]
+[tool.ruff.lint.isort]
+no-lines-before = ["standard-library", "local-folder"]
+known-third-party = []
+known-local-folder = []
+lines-after-imports = 2
+
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/*.py" = ["S101", "S311"]
+
+[tool.coverage.report]
+exclude_also = ["if typing.TYPE_CHECKING:", 'class \w+\(typing.Protocol\):']
+omit = ["tests/*"]
+
+[tool.pytest.ini_options]
+addopts = '--cov=. -p no:warnings --cov-report term-missing'

pyproject.toml

@@ -10,7 +10,8 @@
 from tests.conftest import AsyncMock
 
 
-def test_extra_nodes() -> None:
+# TODO: enable this test, when all discussions here are resolved https://github.com/piccolo-orm/piccolo/issues/986  # noqa: TD002, E501
+def skip_test_extra_nodes() -> None:
     """Make sure that other nodes can be queried."""
     test_engine = engine_finder()
     assert test_engine is not None