chg: linter changes from ruff for py3.12

.github/workflows/verify.yml

@@ -30,8 +30,8 @@ jobs:
           pip list
 
       # Linter.
-      - run: ruff check pyodk tests --no-fix
-      - run: ruff format pyodk tests --diff
+      - run: ruff check pyodk tests docs --no-fix
+      - run: ruff format pyodk tests docs --diff
 
   test:
     runs-on: ${{ matrix.os }}

docs/examples/app_user_provisioner/app_user_provisioner.py

@@ -12,25 +12,25 @@
 
 To run the script, use `python app_user_provisioner.py`.
 """
+
 import base64
 import glob
 import json
 import zlib
-from typing import Any, Dict
+from typing import Any
 
 import segno
 from PIL import Image, ImageDraw, ImageFont, ImageOps
-
 from pyodk.client import Client
 
 # Customise these settings to your environment.
 PROJECT_ID = 149
 PROJECT_NAME = "My Cool Project"
 FORMS_TO_ACCESS = ["all-widgets", "afp-knowledge"]
-ADMIN_PASSWORD = "s00p3rs3cr3t"
+ADMIN_PASSWORD = "s00p3rs3cr3t"  # noqa: S105
 
 
-def get_settings(server_url: str, project_name: str, username: str) -> Dict[str, Any]:
+def get_settings(server_url: str, project_name: str, username: str) -> dict[str, Any]:
     """Template for the settings to encode in the QR image. Customise as needed."""
     return {
         "general": {

pyodk/_endpoints/__init__.py

@@ -1 +1 @@
-__all__ = tuple()
+__all__ = ()

pyodk/_endpoints/auth.py

@@ -1,5 +1,5 @@
 import logging
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING
 
 from pyodk._utils import config
 from pyodk.errors import PyODKError
@@ -11,7 +11,7 @@
 
 
 class AuthService:
-    def __init__(self, session: "Session", cache_path: Optional[str] = None) -> None:
+    def __init__(self, session: "Session", cache_path: str | None = None) -> None:
         self.session: "Session" = session
         self.cache_path: str = cache_path
 

pyodk/_endpoints/bases.py

@@ -1,5 +1,3 @@
-from typing import Dict
-
 from pydantic import BaseModel
 
 from pyodk._utils.session import Session
@@ -17,15 +15,13 @@ class Manager:
     """Base for managers of data model classes."""
 
     __slots__ = ("__weakref__",)
-    pass
 
     @classmethod
-    def from_dict(cls, session: Session, project_id: int, data: Dict) -> Model:
+    def from_dict(cls, session: Session, project_id: int, data: dict) -> Model:
         raise NotImplementedError()
 
 
 class Service:
     """Base for services interacting with the ODK Central API over HTTP."""
 
     __slots__ = ("__weakref__",)
-    pass

pyodk/_endpoints/comments.py

@@ -1,6 +1,5 @@
 import logging
 from datetime import datetime
-from typing import List, Optional
 
 from pyodk._endpoints import bases
 from pyodk._utils import validators as pv
@@ -36,23 +35,23 @@ class CommentService(bases.Service):
     def __init__(
         self,
         session: Session,
-        default_project_id: Optional[int] = None,
-        default_form_id: Optional[str] = None,
-        default_instance_id: Optional[str] = None,
+        default_project_id: int | None = None,
+        default_form_id: str | None = None,
+        default_instance_id: str | None = None,
         urls: URLs = None,
     ):
         self.urls: URLs = urls if urls is not None else URLs()
         self.session: Session = session
-        self.default_project_id: Optional[int] = default_project_id
-        self.default_form_id: Optional[str] = default_form_id
-        self.default_instance_id: Optional[str] = default_instance_id
+        self.default_project_id: int | None = default_project_id
+        self.default_form_id: str | None = default_form_id
+        self.default_instance_id: str | None = default_instance_id
 
     def list(
         self,
-        form_id: Optional[str] = None,
-        project_id: Optional[int] = None,
-        instance_id: Optional[str] = None,
-    ) -> List[Comment]:
+        form_id: str | None = None,
+        project_id: int | None = None,
+        instance_id: str | None = None,
+    ) -> list[Comment]:
         """
         Read all Comment details.
 
@@ -66,7 +65,7 @@ def list(
             iid = pv.validate_instance_id(instance_id, self.default_instance_id)
         except PyODKError as err:
             log.error(err, exc_info=True)
-            raise err
+            raise
 
         response = self.session.response_or_error(
             method="GET",
@@ -81,9 +80,9 @@ def list(
     def post(
         self,
         comment: str,
-        project_id: Optional[int] = None,
-        form_id: Optional[str] = None,
-        instance_id: Optional[str] = None,
+        project_id: int | None = None,
+        form_id: str | None = None,
+        instance_id: str | None = None,
     ) -> Comment:
         """
         Create a Comment.
@@ -103,7 +102,7 @@ def post(
             json = {"body": comment}
         except PyODKError as err:
             log.error(err, exc_info=True)
-            raise err
+            raise
 
         response = self.session.response_or_error(
             method="POST",

pyodk/_endpoints/form_assignments.py

@@ -1,5 +1,4 @@
 import logging
-from typing import Optional
 
 from pyodk._endpoints import bases
 from pyodk._utils import validators as pv
@@ -23,21 +22,21 @@ class FormAssignmentService(bases.Service):
     def __init__(
         self,
         session: Session,
-        default_project_id: Optional[int] = None,
-        default_form_id: Optional[str] = None,
+        default_project_id: int | None = None,
+        default_form_id: str | None = None,
         urls: URLs = None,
     ):
         self.urls: URLs = urls if urls is not None else URLs()
         self.session: Session = session
-        self.default_project_id: Optional[int] = default_project_id
-        self.default_form_id: Optional[str] = default_form_id
+        self.default_project_id: int | None = default_project_id
+        self.default_form_id: str | None = default_form_id
 
     def assign(
         self,
         role_id: int,
         user_id: int,
-        form_id: Optional[str] = None,
-        project_id: Optional[int] = None,
+        form_id: str | None = None,
+        project_id: int | None = None,
     ) -> bool:
         """
         Assign a user to a role for a form.
@@ -54,7 +53,7 @@ def assign(
             uid = pv.validate_int(user_id, key="user_id")
         except PyODKError as err:
             log.error(err, exc_info=True)
-            raise err
+            raise
 
         response = self.session.response_or_error(
             method="POST",

pyodk/_endpoints/form_draft_attachments.py

@@ -1,6 +1,5 @@
 import logging
 from pathlib import Path
-from typing import Optional
 
 from pyodk._endpoints import bases
 from pyodk._utils import validators as pv
@@ -24,21 +23,21 @@ class FormDraftAttachmentService(bases.Service):
     def __init__(
         self,
         session: Session,
-        default_project_id: Optional[int] = None,
-        default_form_id: Optional[str] = None,
+        default_project_id: int | None = None,
+        default_form_id: str | None = None,
         urls: URLs = None,
     ):
         self.urls: URLs = urls if urls is not None else URLs()
         self.session: Session = session
-        self.default_project_id: Optional[int] = default_project_id
-        self.default_form_id: Optional[str] = default_form_id
+        self.default_project_id: int | None = default_project_id
+        self.default_form_id: str | None = default_form_id
 
     def upload(
         self,
         file_path: str,
-        file_name: Optional[str] = None,
-        form_id: Optional[str] = None,
-        project_id: Optional[int] = None,
+        file_name: str | None = None,
+        form_id: str | None = None,
+        project_id: int | None = None,
     ) -> bool:
         """
         Upload a Form Draft Attachment.
@@ -56,7 +55,7 @@ def upload(
                 file_name = pv.validate_str(file_path.name, key="file_name")
         except PyODKError as err:
             log.error(err, exc_info=True)
-            raise err
+            raise
 
         with open(file_path, "rb") as fd:
             response = self.session.response_or_error(

pyodk/_endpoints/form_drafts.py

@@ -1,7 +1,6 @@
 import logging
 from contextlib import nullcontext
 from pathlib import Path
-from typing import Optional
 
 from pyodk._endpoints import bases
 from pyodk._utils import validators as pv
@@ -26,21 +25,21 @@ class FormDraftService(bases.Service):
     def __init__(
         self,
         session: Session,
-        default_project_id: Optional[int] = None,
-        default_form_id: Optional[str] = None,
+        default_project_id: int | None = None,
+        default_form_id: str | None = None,
         urls: URLs = None,
     ):
         self.urls: URLs = urls if urls is not None else URLs()
         self.session: Session = session
-        self.default_project_id: Optional[int] = default_project_id
-        self.default_form_id: Optional[str] = default_form_id
+        self.default_project_id: int | None = default_project_id
+        self.default_form_id: str | None = default_form_id
 
     def create(
         self,
-        file_path: Optional[str] = None,
-        ignore_warnings: Optional[bool] = True,
-        form_id: Optional[str] = None,
-        project_id: Optional[int] = None,
+        file_path: str | None = None,
+        ignore_warnings: bool | None = True,
+        form_id: str | None = None,
+        project_id: int | None = None,
     ) -> bool:
         """
         Create a Form Draft.
@@ -70,7 +69,7 @@ def create(
                 elif file_path.suffix == ".xml":
                     content_type = "application/xml"
                 else:
-                    raise PyODKError(
+                    raise PyODKError(  # noqa: TRY301
                         "Parameter 'file_path' file name has an unexpected extension, "
                         "expected one of '.xlsx', '.xls', '.xml'."
                     )
@@ -80,7 +79,7 @@ def create(
                 }
         except PyODKError as err:
             log.error(err, exc_info=True)
-            raise err
+            raise
 
         with open(file_path, "rb") if file_path is not None else nullcontext() as fd:
             response = self.session.response_or_error(
@@ -97,9 +96,9 @@ def create(
 
     def publish(
         self,
-        form_id: Optional[str] = None,
-        project_id: Optional[int] = None,
-        version: Optional[str] = None,
+        form_id: str | None = None,
+        project_id: int | None = None,
+        version: str | None = None,
     ) -> bool:
         """
         Publish a Form Draft.
@@ -117,7 +116,7 @@ def publish(
                 params[key] = pv.validate_str(version, key=key)
         except PyODKError as err:
             log.error(err, exc_info=True)
-            raise err
+            raise
 
         response = self.session.response_or_error(
             method="POST",