ci(pre-commit): add a pre-commit job to CI

.circleci/config.yml

@@ -1,10 +1,43 @@
 version: 2.1
 
 orbs:
-  python: circleci/python@2.0.3
-  codecov: codecov/codecov@3.2.2
+  codecov: codecov/codecov@3.3.0
 
 jobs:
+  pre-commit:
+    parameters:
+      config_file:
+        default: ./.pre-commit-config.yaml
+        description: Optional, path to pre-commit config file.
+        type: string
+      cache_prefix:
+        default: ''
+        description: |
+          Optional cache prefix to be used on CircleCI. Can be used for cache busting or to ensure multiple jobs use different caches.
+        type: string
+    docker:
+      - image: speckle/pre-commit-runner:latest
+    resource_class: medium
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - cache-pre-commit-<<parameters.cache_prefix>>-{{ checksum "<<parameters.config_file>>" }}
+      - run:
+          name: Install pre-commit hooks
+          command: pre-commit install-hooks --config <<parameters.config_file>>
+      - save_cache:
+          key: cache-pre-commit-<<parameters.cache_prefix>>-{{ checksum "<<parameters.config_file>>" }}
+          paths:
+            - ~/.cache/pre-commit
+      - run:
+          name: Run pre-commit
+          command: pre-commit run --all-files
+      - run:
+          command: git --no-pager diff
+          name: git diff
+          when: on_fail
+
   test:
     machine:
       image: ubuntu-2204:2023.02.1
@@ -52,6 +85,10 @@ jobs:
 workflows:
   main:
     jobs:
+      - pre-commit:
+          filters:
+            tags:
+              only: /.*/
       - test:
           matrix:
             parameters:
@@ -62,6 +99,7 @@ workflows:
       - deploy:
           context: pypi
           requires:
+            - pre-commit
             - test
           filters:
             tags:

.pre-commit-config.yaml

@@ -2,23 +2,23 @@ repos:
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     hooks:
       - id: ruff
-    rev: v0.0.186
+    rev: v0.1.6
 
   - repo: https://github.com/commitizen-tools/commitizen
     hooks:
     - id: commitizen
     - id: commitizen-branch
       stages:
       - push
-    rev: v2.38.0
+    rev: 3.12.0
 
   - repo: https://github.com/pycqa/isort
-    rev: v5.11.3
+    rev: 5.12.0
     hooks:
       - id: isort
 
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.11.0
     hooks:
       - id: black
         # It is recommended to specify the latest version of Python
@@ -27,7 +27,7 @@ repos:
         # https://pre-commit.com/#top_level-default_language_version
         # language_version: python3.11
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace

src/speckle_automate/automation_context.py

@@ -1,18 +1,11 @@
 """This module provides an abstraction layer above the Speckle Automate runtime."""
+import time
 from dataclasses import dataclass, field
 from pathlib import Path
-import time
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import httpx
 from gql import gql
-from specklepy.api import operations
-from specklepy.api.client import SpeckleClient
-from specklepy.core.api.models import Branch
-from specklepy.objects import Base
-from specklepy.transports.memory import MemoryTransport
-from specklepy.transports.server import ServerTransport
-from specklepy.logging.exceptions import SpeckleException
 
 from speckle_automate.schema import (
     AutomateBase,
@@ -22,6 +15,12 @@
     ObjectResultLevel,
     ResultCase,
 )
+from specklepy.api import operations
+from specklepy.api.client import SpeckleClient
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.objects import Base
+from specklepy.transports.memory import MemoryTransport
+from specklepy.transports.server import ServerTransport
 
 
 @dataclass
@@ -196,8 +195,8 @@ def report_run_status(self) -> None:
         query = gql(
             """
             mutation ReportFunctionRunStatus(
-                $automationId: String!, 
-                $automationRevisionId: String!, 
+                $automationId: String!,
+                $automationRevisionId: String!,
                 $automationRunId: String!,
                 $versionId: String!,
                 $functionId: String!,

src/speckle_automate/helpers.py

@@ -2,9 +2,10 @@
 import secrets
 import string
 
-from specklepy.api.client import SpeckleClient
 from gql import gql
 
+from specklepy.api.client import SpeckleClient
+
 
 def register_new_automation(
     speckle_client: SpeckleClient,
@@ -18,18 +19,18 @@ def register_new_automation(
     query = gql(
         """
         mutation CreateAutomation(
-            $projectId: String! 
-            $modelId: String! 
+            $projectId: String!
+            $modelId: String!
             $automationName: String!
-            $automationId: String! 
+            $automationId: String!
             $automationRevisionId: String!
         ) {
                 automationMutations {
                     create(
                         input: {
                             projectId: $projectId
                             modelId: $modelId
-                            automationName: $automationName 
+                            automationName: $automationName
                             automationId: $automationId
                             automationRevisionId: $automationRevisionId
                         }

src/speckle_automate/runner.py

@@ -11,7 +11,7 @@
 from typing import Callable, Optional, TypeVar, Union, overload
 
 from speckle_automate.automation_context import AutomationContext
-from speckle_automate.schema import AutomateBase, AutomationRunData, AutomationStatus
+from speckle_automate.schema import AutomateBase, AutomationStatus
 
 T = TypeVar("T", bound=AutomateBase)
 

src/specklepy/api/client.py

@@ -1,11 +1,7 @@
 from deprecated import deprecated
-from gql.transport.exceptions import TransportServerError
-from gql.transport.requests import RequestsHTTPTransport
-from gql.transport.websockets import WebsocketsTransport
 
-from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.api.credentials import Account
 from specklepy.api.resources import (
-    user,
     active_user,
     branch,
     commit,
@@ -14,11 +10,10 @@
     server,
     stream,
     subscriptions,
+    user,
 )
-from specklepy.logging import metrics
-from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
-
 from specklepy.core.api.client import SpeckleClient as CoreSpeckleClient
+from specklepy.logging import metrics
 
 
 class SpeckleClient(CoreSpeckleClient):

src/specklepy/api/credentials.py

@@ -1,23 +1,14 @@
-import os
 from typing import List, Optional
 
-from pydantic import BaseModel, Field  # pylint: disable=no-name-in-module
-
-from specklepy.api.models import ServerInfo
-from specklepy.core.helpers import speckle_path_provider
-from specklepy.logging import metrics
-from specklepy.logging.exceptions import SpeckleException
-from specklepy.transports.sqlite import SQLiteTransport
-
 # following imports seem to be unnecessary, but they need to stay
 # to not break the scripts using these functions as non-core
+from specklepy.core.api.credentials import StreamWrapper  # noqa: F401
+from specklepy.core.api.credentials import Account, UserInfo  # noqa: F401
 from specklepy.core.api.credentials import (
-    Account,
-    UserInfo,
-    StreamWrapper,  # deprecated
-    get_local_accounts as core_get_local_accounts,
     get_account_from_token as core_get_account_from_token,
 )
+from specklepy.core.api.credentials import get_local_accounts as core_get_local_accounts
+from specklepy.logging import metrics
 
 
 def get_local_accounts(base_path: Optional[str] = None) -> List[Account]:

src/specklepy/api/host_applications.py

@@ -1,18 +1,74 @@
-from dataclasses import dataclass
-from enum import Enum
-from unicodedata import name
+from specklepy.core.api.host_applications import (
+    ARCGIS,
+    ARCHICAD,
+    AUTOCAD,
+    BLENDER,
+    CIVIL,
+    CSIBRIDGE,
+    DXF,
+    DYNAMO,
+    ETABS,
+    EXCEL,
+    GRASSHOPPER,
+    GSA,
+    MICROSTATION,
+    NET,
+    OPENBUILDINGS,
+    OPENRAIL,
+    OPENROADS,
+    OTHER,
+    POWERBI,
+    PYTHON,
+    QGIS,
+    REVIT,
+    RHINO,
+    SAFE,
+    SAP2000,
+    SKETCHUP,
+    TEKLASTRUCTURES,
+    TOPSOLID,
+    UNITY,
+    UNREAL,
+    HostApplication,
+    HostAppVersion,
+    _app_name_host_app_mapping,
+    get_host_app_from_string,
+)
 
-# following imports seem to be unnecessary, but they need to stay 
-# to not break the scripts using these functions as non-core
-from specklepy.core.api.host_applications import (HostApplication, HostAppVersion,
-                                                  get_host_app_from_string, 
-                                                  _app_name_host_app_mapping,
-                                                  RHINO,GRASSHOPPER,REVIT,DYNAMO,UNITY,GSA,
-                                                  CIVIL,AUTOCAD,MICROSTATION,OPENROADS,
-                                                  OPENRAIL,OPENBUILDINGS,ETABS,SAP2000,CSIBRIDGE,
-                                                  SAFE,TEKLASTRUCTURES,DXF,EXCEL,UNREAL,POWERBI,
-                                                  BLENDER,QGIS,ARCGIS,SKETCHUP,ARCHICAD,TOPSOLID,
-                                                  PYTHON,NET,OTHER)
-
-if __name__ == "__main__":
-    print(HostAppVersion.v)
+# re-exporting stuff from the moved api module
+__all__ = [
+    "ARCGIS",
+    "ARCHICAD",
+    "AUTOCAD",
+    "BLENDER",
+    "CIVIL",
+    "CSIBRIDGE",
+    "DXF",
+    "DYNAMO",
+    "ETABS",
+    "EXCEL",
+    "GRASSHOPPER",
+    "GSA",
+    "MICROSTATION",
+    "NET",
+    "OPENBUILDINGS",
+    "OPENRAIL",
+    "OPENROADS",
+    "OTHER",
+    "POWERBI",
+    "PYTHON",
+    "QGIS",
+    "REVIT",
+    "RHINO",
+    "SAFE",
+    "SAP2000",
+    "SKETCHUP",
+    "TEKLASTRUCTURES",
+    "TOPSOLID",
+    "UNITY",
+    "UNREAL",
+    "HostApplication",
+    "HostAppVersion",
+    "_app_name_host_app_mapping",
+    "get_host_app_from_string",
+]

src/specklepy/api/models.py

@@ -1,12 +1,35 @@
-from datetime import datetime
-from typing import List, Optional
-
-from pydantic import BaseModel, Field
-
-# following imports seem to be unnecessary, but they need to stay 
+# following imports seem to be unnecessary, but they need to stay
 # to not break the scripts using these functions as non-core
-from specklepy.core.api.models import (Collaborator, Commit,
-                                       Commits, Object, Branch, Branches,
-                                       Stream, Streams, User, LimitedUser,
-                                       PendingStreamCollaborator, Activity,
-                                       ActivityCollection, ServerInfo)
+from specklepy.core.api.models import (
+    Activity,
+    ActivityCollection,
+    Branch,
+    Branches,
+    Collaborator,
+    Commit,
+    Commits,
+    LimitedUser,
+    Object,
+    PendingStreamCollaborator,
+    ServerInfo,
+    Stream,
+    Streams,
+    User,
+)
+
+__all__ = [
+    "Activity",
+    "ActivityCollection",
+    "Branch",
+    "Branches",
+    "Collaborator",
+    "Commit",
+    "Commits",
+    "LimitedUser",
+    "Object",
+    "PendingStreamCollaborator",
+    "ServerInfo",
+    "Stream",
+    "Streams",
+    "User",
+]