build: Embrace ruff (#319)

Author: schloerke

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+	"recommendations": [
+		"charliermarsh.ruff"
+	]
+}

.vscode/settings.json

@@ -1,7 +1,24 @@
 {
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true,
+    "files.encoding": "utf8",
+    "files.eol": "\n",
     "python.testing.pytestArgs": [
         "tests"
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.formatOnSave": true,
+        "editor.tabSize": 4,
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        }
+    },
+    "files.exclude": {
+        "**/__pycache__": true,
+        "build/**": true
+    },
+    "editor.rulers": [99],
 }

examples/connect/databricks/dash/app.py

@@ -23,7 +23,7 @@
         html.Div(id="greeting", children="Loading..."),
         html.Div(id="table-container"),
         html.Div(id="dummy"),  # dummy element to trigger callback on page load
-    ]
+    ],
 )
 
 
@@ -38,7 +38,8 @@ def update_page(_):
     """
     session_token = flask.request.headers.get("Posit-Connect-User-Session-Token")
     posit_strategy = PositCredentialsStrategy(
-        local_strategy=databricks_cli, user_session_token=session_token
+        local_strategy=databricks_cli,
+        user_session_token=session_token,
     )
     cfg = Config(
         host=DATABRICKS_HOST_URL,

examples/connect/databricks/fastapi/app.py

@@ -1,15 +1,19 @@
 # -*- coding: utf-8 -*-
 # mypy: ignore-errors
+from __future__ import annotations
+
 import os
-from typing import Annotated
+from typing import TYPE_CHECKING, Annotated
 
 from databricks import sql
 from databricks.sdk.core import Config, databricks_cli
 from fastapi import FastAPI, Header
-from fastapi.responses import JSONResponse
 
 from posit.connect.external.databricks import PositCredentialsStrategy
 
+if TYPE_CHECKING:
+    from fastapi.responses import JSONResponse
+
 DATABRICKS_HOST = os.getenv("DATABRICKS_HOST")
 DATABRICKS_HOST_URL = f"https://{DATABRICKS_HOST}"
 SQL_HTTP_PATH = os.getenv("DATABRICKS_PATH")

examples/connect/databricks/flask/app.py

@@ -31,7 +31,8 @@ def get_fares():
 
     session_token = request.headers.get("Posit-Connect-User-Session-Token")
     posit_strategy = PositCredentialsStrategy(
-        local_strategy=databricks_cli, user_session_token=session_token
+        local_strategy=databricks_cli,
+        user_session_token=session_token,
     )
     cfg = Config(
         host=DATABRICKS_HOST_URL,

examples/connect/databricks/shiny/app.py

@@ -24,7 +24,8 @@ def server(i: Inputs, o: Outputs, session: Session):
     """
     session_token = session.http_conn.headers.get("Posit-Connect-User-Session-Token")
     posit_strategy = PositCredentialsStrategy(
-        local_strategy=databricks_cli, user_session_token=session_token
+        local_strategy=databricks_cli,
+        user_session_token=session_token,
     )
     cfg = Config(
         host=DATABRICKS_HOST_URL,

examples/connect/databricks/streamlit/app.py

@@ -16,7 +16,8 @@
 
 session_token = st.context.headers.get("Posit-Connect-User-Session-Token")
 posit_strategy = PositCredentialsStrategy(
-    local_strategy=databricks_cli, user_session_token=session_token
+    local_strategy=databricks_cli,
+    user_session_token=session_token,
 )
 cfg = Config(
     host=DATABRICKS_HOST_URL,

integration/tests/posit/connect/test_users.py

@@ -6,13 +6,19 @@ class TestUser:
     def setup_class(cls):
         cls.client = client = connect.Client()
         cls.aron = client.users.create(
-            username="aron", email="[email protected]", password="s3cur3p@ssword"
+            username="aron",
+            email="[email protected]",
+            password="s3cur3p@ssword",
         )
         cls.bill = client.users.create(
-            username="bill", email="[email protected]", password="s3cur3p@ssword"
+            username="bill",
+            email="[email protected]",
+            password="s3cur3p@ssword",
         )
         cls.cole = client.users.create(
-            username="cole", email="[email protected]", password="s3cur3p@ssword"
+            username="cole",
+            email="[email protected]",
+            password="s3cur3p@ssword",
         )
 
     def test_lock(self):
@@ -71,7 +77,9 @@ def test_find_one(self):
 
     def test_multiple_users(self):
         user = self.client.users.create(
-            username="example", email="[email protected]", password="s3cur3p@ssword"
+            username="example",
+            email="[email protected]",
+            password="s3cur3p@ssword",
         )
         # assert filtering limits to the provided user.
         assert self.me.content.find_one() == self.content

pyproject.toml

@@ -44,7 +44,19 @@ docstring-code-format = true
 docstring-code-line-length = "dynamic"
 
 [tool.ruff.lint]
-select = [
+extend-ignore = [
+    "E501",   # Line too long
+    "PT011",  # `pytest.raises(ValueError)` is too broad
+    "PT022",  # No teardown in fixture
+    "F841",   # Local variable is assigned but never used
+    "COM812", # missing-trailing-comma
+    "ISC001", # single-line-implicit-string-concatenation
+    "ISC002", # multi-line-implicit-string-concatenation
+]
+extend-select = [
+    # "C90", # Many false positives # C90; mccabe: https://docs.astral.sh/ruff/rules/complex-structure/
+    # "DTZ", # Dates with timezones are different from dates without timezones # DTZ; flake8-datetimez: https://docs.astral.sh/ruff/rules/#flake8-datetimez-dtz
+
     # flake8-builtins
     # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
     #
@@ -58,17 +70,28 @@ select = [
     # Check docstring formatting. Many of these rules are intentionally ignored below.
     "D",
 
-    # pyflakes - unused-import
-    # https://docs.astral.sh/ruff/rules/unused-import/
-    #
-    # Check for unused imports.
-    "F401",
-
-    # isort
-    # https://docs.astral.sh/ruff/rules/#isort-i
-    #
-    # Sort imports.
-    "I",
+    "E",      # E; pycodestyle: https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "F",      # F; Pyflakes: https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "I",      # I; isort: https://docs.astral.sh/ruff/rules/#isort-i
+    "B",      # B; flake8-bugbear: https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "Q",      # Q; flake8-quotes: https://docs.astral.sh/ruff/rules/#flake8-quotes-q
+    "COM",    # COM; Commas: https://docs.astral.sh/ruff/rules/#flake8-commas-com
+    "C4",     # C4; flake8-comprehensions: https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+    "FA102",  # FA102; flake8-future-annotations: https://docs.astral.sh/ruff/rules/#flake8-future-annotations-fa
+    "ISC",    # ISC; flake8-implicit-str-concat: https://docs.astral.sh/ruff/rules/#flake8-implicit-str-concat-isc
+    "ICN",    # ICN; flake8-import-conventions: https://docs.astral.sh/ruff/rules/#flake8-import-conventions-icn
+    "PIE",    # PIE; flake8-pie: https://docs.astral.sh/ruff/rules/#flake8-pie-pie
+    "PYI013", # PYI013; flake8-pyi Non-empty class body must not contain `...`: https://docs.astral.sh/ruff/rules/#flake8-pyi-pyi
+    "PYI030", # PYI030; flake8-pyi Multiple literal members in a union: https://docs.astral.sh/ruff/rules/#flake8-pyi-pyi
+    "PYI034", # PYI034; flake8-pyi `__new__` methods usually reutrn `Self`: https://docs.astral.sh/ruff/rules/#flake8-pyi-pyi
+    "PT",     # PT; flake8-pytest-style: https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
+    "SIM118", # SIM118; flake8-simplify Use `key {operator} dict`: https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+    "TCH",    # TCH; flake8-type-checking: https://docs.astral.sh/ruff/rules/#flake8-type-checking-tch
+    # "FIX", # FIX; flake8-fixme: https://docs.astral.sh/ruff/rules/#flake8-fixme-fix
+    # "PGH", # PGH; pygrep-hooks: https://docs.astral.sh/ruff/rules/#pygrep-hooks-pgh
+    "NPY",    # NPY; NumPy-specific rules: https://docs.astral.sh/ruff/rules/#numpy-specific-rules-npy
+    "RUF005", # RUF005; Ruff specific rules Consider {expression} instead of concatenation: https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+    "RUF100", # RUF100; Ruff specific rules Unused `noqa` directive https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
 ]
 ignore = [
     # NumPy style docstring convention with noted exceptions.
@@ -95,6 +118,14 @@ ignore = [
 [tool.ruff.lint.pydocstyle]
 convention = "numpy"
 
+# # Ruff is enabled in config file to run on save
+# Disable isort due to timing conflict with ruff
+[tool.isort]
+skip_glob = "**"
+# Disable local black to avoid conflict with ruff
+[tool.black]
+exclude = ".*"
+
 
 [dependency-groups]
 build = ["build"]

src/posit/connect/bundles.py

@@ -74,7 +74,7 @@ def download(self, output: io.BufferedWriter | str) -> None:
         """
         if not isinstance(output, (io.BufferedWriter, str)):
             raise TypeError(
-                f"download() expected argument type 'io.BufferedWriter` or 'str', but got '{type(output).__name__}'"
+                f"download() expected argument type 'io.BufferedWriter` or 'str', but got '{type(output).__name__}'",
             )
 
         path = f"v1/content/{self.content_guid}/bundles/{self.id}/download"
@@ -160,7 +160,7 @@ def create(self, archive: io.BufferedReader | bytes | str) -> Bundle:
                 data = file.read()
         else:
             raise TypeError(
-                f"create() expected argument type 'io.BufferedReader', 'bytes', or 'str', but got '{type(archive).__name__}'"
+                f"create() expected argument type 'io.BufferedReader', 'bytes', or 'str', but got '{type(archive).__name__}'",
             )
 
         path = f"v1/content/{self.content_guid}/bundles"