Merge branch 'main' of github.com:specklesystems/specklepy into v3-dev

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ repos:
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     hooks:
       - id: ruff
-    rev: v0.1.6
+    rev: v0.8.2
 
   - repo: https://github.com/commitizen-tools/commitizen
     hooks:
@@ -13,12 +13,12 @@ repos:
     rev: v3.13.0
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
 
   - repo: https://github.com/psf/black
-    rev: 23.11.0
+    rev: 24.10.0
     hooks:
       - id: black
         # It is recommended to specify the latest version of Python

pyproject.toml

@@ -27,19 +27,19 @@ httpx = "^0.25.0"
 pydantic-settings = "^2.6.1"
 
 [tool.poetry.group.dev.dependencies]
-black = "23.11.0"
-isort = "^5.7.0"
+black = "24.10.0"
+isort = "^5.13.2"
 pytest = "^7.1.3"
 pytest-asyncio = "^0.23.0"
 pytest-ordering = "^0.6"
 pytest-cov = "^3.0.0"
 devtools = "^0.8.0"
-pylint = "^2.14.4"
+pylint = "^3.3.2"
 pydantic-settings = "^2.3.0"
 mypy = "^0.982"
 pre-commit = "^2.20.0"
-commitizen = "^2.38.0"
-ruff = "^0.4.4"
+commitizen = "^3.13.0"
+ruff = "^0.8.2"
 types-deprecated = "^1.2.9"
 types-ujson = "^5.6.0.0"
 types-requests = "^2.28.11.5"
@@ -61,8 +61,7 @@ exclude = '''
 '''
 include = '\.pyi?$'
 line-length = 88
-target-version = ["py37", "py38", "py39", "py310", "py311"]
-
+target-version = ["py39", "py310", "py311", "py312", "py313"]
 
 [tool.commitizen]
 name = "cz_conventional_commits"

src/speckle_automate/fixtures.py

@@ -1,4 +1,5 @@
 """Some useful helpers for working with automation data."""
+
 import secrets
 import string
 

src/speckle_automate/runner.py

@@ -61,15 +61,13 @@ class FunctionRunData(AutomateBase):
 def execute_automate_function(
     automate_function: AutomateFunction[T],
     input_schema: type[T],
-) -> None:
-    ...
+) -> None: ...
 
 
 @overload
 def execute_automate_function(
     automate_function: AutomateFunctionWithoutInputs,
-) -> None:
-    ...
+) -> None: ...
 
 
 class AutomateGenerateJsonSchema(GenerateJsonSchema):
@@ -146,16 +144,14 @@ def run_function(
     automation_context: AutomationContext,
     automate_function: AutomateFunction[T],
     inputs: T,
-) -> AutomationContext:
-    ...
+) -> AutomationContext: ...
 
 
 @overload
 def run_function(
     automation_context: AutomationContext,
     automate_function: AutomateFunctionWithoutInputs,
-) -> AutomationContext:
-    ...
+) -> AutomationContext: ...
 
 
 def run_function(

src/specklepy/api/client.py

@@ -7,12 +7,12 @@
     OtherUserResource,
     ProjectInviteResource,
     ProjectResource,
+    ServerResource,
     SubscriptionResource,
     VersionResource,
     branch,
     commit,
     object,
-    server,
     stream,
     subscriptions,
     user,
@@ -69,7 +69,7 @@ def __init__(
         self.account = Account()
 
     def _init_resources(self) -> None:
-        self.server = server.Resource(
+        self.server = ServerResource(
             account=self.account, basepath=self.url, client=self.httpclient
         )
 

src/specklepy/api/resources/current/active_user_resource.py

@@ -3,8 +3,7 @@
 
 from deprecated import deprecated
 
-from specklepy.core.api.inputs.project_inputs import UserProjectsFilter
-from specklepy.core.api.inputs.user_inputs import UserUpdateInput
+from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
 from specklepy.core.api.models import (
     PendingStreamCollaborator,
     Project,
@@ -44,12 +43,10 @@ def update(
         company: Optional[str] = None,
         bio: Optional[str] = None,
         avatar: Optional[str] = None,
-    ) -> User:
-        ...
+    ) -> User: ...
 
     @overload
-    def update(self, *, input: UserUpdateInput) -> User:
-        ...
+    def update(self, *, input: UserUpdateInput) -> User: ...
 
     def update(
         self,

src/specklepy/api/resources/deprecated/server.py

@@ -4,6 +4,6 @@
 from specklepy.core.api.models.deprecated import FE1_DEPRECATION_VERSION
 
 
-@deprecated(reason="Renamed to ActiveUserResource", version=FE1_DEPRECATION_VERSION)
+@deprecated(reason="Renamed to ServerResource", version=FE1_DEPRECATION_VERSION)
 class Resource(ServerResource):
     """Renamed to ServerResource"""

src/specklepy/core/api/inputs/__init__.py

@@ -0,0 +1,42 @@
+from specklepy.core.api.inputs.model_inputs import (
+    CreateModelInput,
+    DeleteModelInput,
+    ModelVersionsFilter,
+    UpdateModelInput,
+)
+from specklepy.core.api.inputs.project_inputs import (
+    ProjectCreateInput,
+    ProjectInviteCreateInput,
+    ProjectInviteUseInput,
+    ProjectModelsFilter,
+    ProjectUpdateInput,
+    ProjectUpdateRoleInput,
+)
+from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
+from specklepy.core.api.inputs.version_inputs import (
+    CreateVersionInput,
+    DeleteVersionsInput,
+    MarkReceivedVersionInput,
+    MoveVersionsInput,
+    UpdateVersionInput,
+)
+
+__all__ = [
+    "CreateModelInput",
+    "DeleteModelInput",
+    "UpdateModelInput",
+    "ModelVersionsFilter",
+    "ProjectCreateInput",
+    "ProjectInviteCreateInput",
+    "ProjectInviteUseInput",
+    "ProjectModelsFilter",
+    "ProjectUpdateInput",
+    "ProjectUpdateRoleInput",
+    "UserProjectsFilter",
+    "UserUpdateInput",
+    "UpdateVersionInput",
+    "MoveVersionsInput",
+    "DeleteVersionsInput",
+    "CreateVersionInput",
+    "MarkReceivedVersionInput",
+]

src/specklepy/core/api/inputs/project_inputs.py

@@ -45,8 +45,3 @@ class ProjectUpdateRoleInput(BaseModel):
     userId: str
     projectId: str
     role: Optional[str]
-
-
-class UserProjectsFilter(BaseModel):
-    search: str
-    onlyWithRole: Optional[Sequence[str]] = None

src/specklepy/core/api/inputs/user_inputs.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, Sequence
 
 from pydantic import BaseModel
 
@@ -8,3 +8,8 @@ class UserUpdateInput(BaseModel):
     bio: Optional[str] = None
     company: Optional[str] = None
     name: Optional[str] = None
+
+
+class UserProjectsFilter(BaseModel):
+    search: str
+    onlyWithRoles: Optional[Sequence[str]] = None

src/specklepy/core/api/resources/current/active_user_resource.py

@@ -4,8 +4,7 @@
 from deprecated import deprecated
 from gql import gql
 
-from specklepy.core.api.inputs.project_inputs import UserProjectsFilter
-from specklepy.core.api.inputs.user_inputs import UserUpdateInput
+from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
 from specklepy.core.api.models import (
     ActivityCollection,
     PendingStreamCollaborator,
@@ -100,12 +99,10 @@ def update(
         company: Optional[str] = None,
         bio: Optional[str] = None,
         avatar: Optional[str] = None,
-    ) -> User:
-        ...
+    ) -> User: ...
 
     @overload
-    def update(self, *, input: UserUpdateInput) -> User:
-        ...
+    def update(self, *, input: UserUpdateInput) -> User: ...
 
     def update(
         self,

src/specklepy/core/api/resources/current/model_resource.py

@@ -127,9 +127,11 @@ def get_with_versions(
             "modelId": model_id,
             "versionsLimit": versions_limit,
             "versionsCursor": versions_cursor,
-            "versionsFilter": versions_filter.model_dump(warnings="error")
-            if versions_filter
-            else None,
+            "versionsFilter": (
+                versions_filter.model_dump(warnings="error")
+                if versions_filter
+                else None
+            ),
         }
 
         return self.make_request_and_parse_response(
@@ -179,9 +181,9 @@ def get_models(
             "projectId": project_id,
             "modelsLimit": models_limit,
             "modelsCursor": models_cursor,
-            "modelsFilter": models_filter.model_dump(warnings="error")
-            if models_filter
-            else None,
+            "modelsFilter": (
+                models_filter.model_dump(warnings="error") if models_filter else None
+            ),
         }
 
         return self.make_request_and_parse_response(

src/specklepy/core/api/resources/current/project_resource.py

@@ -108,9 +108,9 @@ def get_with_models(
             "projectId": project_id,
             "modelsLimit": models_limit,
             "modelsCursor": models_cursor,
-            "modelsFilter": models_filter.model_dump(warnings="error")
-            if models_filter
-            else None,
+            "modelsFilter": (
+                models_filter.model_dump(warnings="error") if models_filter else None
+            ),
         }
 
         return self.make_request_and_parse_response(

src/specklepy/core/api/resources/deprecated/stream.py

@@ -111,7 +111,7 @@ def list(self, stream_limit: int = 10) -> List[Stream]:
         query = gql(
             """
             query User($stream_limit: Int!) {
-                user {
+                activeUser {
                     id
                     bio
                     name
@@ -149,7 +149,7 @@ def list(self, stream_limit: int = 10) -> List[Stream]:
         params = {"stream_limit": stream_limit}
 
         return self.make_request(
-            query=query, params=params, return_type=["user", "streams", "items"]
+            query=query, params=params, return_type=["activeUser", "streams", "items"]
         )
 
     @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)

src/specklepy/core/helpers/speckle_path_provider.py

@@ -1,6 +1,7 @@
 """
 Provides uniform and consistent path helpers for `specklepy`
 """
+
 import os
 import sys
 from pathlib import Path

src/specklepy/objects/other.py

@@ -295,9 +295,9 @@ class RevitParameter(Base, speckle_type="Objects.BuiltElements.Revit.Parameter")
     value: Any = None
     applicationUnitType: Optional[str] = None  # eg UnitType UT_Length
     applicationUnit: Optional[str] = None  # DisplayUnitType eg DUT_MILLIMITERS
-    applicationInternalName: Optional[
-        str
-    ] = None  # BuiltInParameterName or GUID for shared parameter
+    applicationInternalName: Optional[str] = (
+        None  # BuiltInParameterName or GUID for shared parameter
+    )
     isShared: bool = False
     isReadOnly: bool = False
     isTypeParameter: bool = False

tests/integration/client/current/test_active_user_resource.py

@@ -2,7 +2,7 @@
 
 from specklepy.api.client import SpeckleClient
 from specklepy.core.api.inputs.project_inputs import ProjectCreateInput
-from specklepy.core.api.inputs.user_inputs import UserUpdateInput
+from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
 from specklepy.core.api.models import ResourceCollection, User
 
 
@@ -42,3 +42,21 @@ def test_active_user_get_projects(self, client: SpeckleClient):
         assert len(res.items) == len(existing.items) + 2
         assert any(project.id == p1.id for project in res.items)
         assert any(project.id == p2.id for project in res.items)
+
+    def test_active_user_get_projects_with_filter(self, client: SpeckleClient):
+        # Since the client may be reused for other tests,
+        # this test does rely on no other test creating a project with "Search for me" in its name
+        p1 = client.project.create(
+            ProjectCreateInput(name="Search for me!", description=None, visibility=None)
+        )
+        _ = client.project.create(
+            ProjectCreateInput(name="But not me!", description=None, visibility=None)
+        )
+        filter = UserProjectsFilter(search="Search for me")
+
+        res = client.active_user.get_projects(filter=filter)
+
+        assert isinstance(res, ResourceCollection)
+        assert len(res.items) == 1
+        assert res.totalCount == 1
+        assert res.items[0].id == p1.id