Merge branch 'develop' into atg-20250106-ihs-71

Author: minitriga

.github/workflows/ci.yml

@@ -75,7 +75,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        run: "pip install ruff==0.7.1"
+        run: "pip install ruff==0.8.6"
       - name: "Linting: ruff check"
         run: "ruff check ."
       - name: "Linting: ruff format"

changelog/158.added.me

@@ -0,0 +1 @@
+Add `count` method to both sync and async clients to retrieve the number of objects of a given kind

infrahub_sdk/client.py

@@ -525,6 +525,25 @@ async def _process_nodes_and_relationships(
 
         return ProcessRelationsNode(nodes=nodes, related_nodes=related_nodes)
 
+    async def count(
+        self,
+        kind: str | type[SchemaType],
+        at: Timestamp | None = None,
+        branch: str | None = None,
+        timeout: int | None = None,
+    ) -> int:
+        """Return the number of nodes of a given kind."""
+        schema = await self.schema.get(kind=kind, branch=branch)
+
+        branch = branch or self.default_branch
+        if at:
+            at = Timestamp(at)
+
+        response = await self.execute_graphql(
+            query=Query(query={schema.kind: {"count": None}}).render(), branch_name=branch, at=at, timeout=timeout
+        )
+        return int(response.get(schema.kind, {}).get("count", 0))
+
     @overload
     async def all(
         self,
@@ -1585,6 +1604,25 @@ def execute_graphql(
 
         # TODO add a special method to execute mutation that will check if the method returned OK
 
+    def count(
+        self,
+        kind: str | type[SchemaType],
+        at: Timestamp | None = None,
+        branch: str | None = None,
+        timeout: int | None = None,
+    ) -> int:
+        """Return the number of nodes of a given kind."""
+        schema = self.schema.get(kind=kind, branch=branch)
+
+        branch = branch or self.default_branch
+        if at:
+            at = Timestamp(at)
+
+        response = self.execute_graphql(
+            query=Query(query={schema.kind: {"count": None}}).render(), branch_name=branch, at=at, timeout=timeout
+        )
+        return int(response.get(schema.kind, {}).get("count", 0))
+
     @overload
     def all(
         self,

infrahub_sdk/data.py

@@ -2,7 +2,7 @@
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from .node import InfrahubNode  # noqa: TCH001
+from .node import InfrahubNode  # noqa: TC001
 
 
 class RepositoryBranchInfo(BaseModel):
@@ -13,7 +13,8 @@ class RepositoryData(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
     repository: InfrahubNode = Field(..., description="InfrahubNode representing a Repository")
     branches: dict[str, str] = Field(
-        ..., description="Dictionary with the name of the branch as the key and the active commit id as the value"
+        ...,
+        description="Dictionary with the name of the branch as the key and the active commit id as the value",
     )
 
     branch_info: dict[str, RepositoryBranchInfo] = Field(default_factory=dict)

poetry.lock

@@ -67,7 +67,7 @@ pre-commit = "^2.20.0"
 types-toml = "*"
 types-ujson = "*"
 types-pyyaml = "*"
-ruff = "0.7.1"
+ruff = "0.8.6"
 pytest-xdist = "^3.3.1"
 types-python-slugify = "^8.0.0.3"
 invoke = "^2.2.0"
@@ -252,6 +252,7 @@ ignore = [
     "FURB110", # Replace ternary `if` expression with `or` operator
     "FURB113", # Use `lines.extend((" " * self.indentation + "}", "}"))` instead of repeatedly calling `lines.append()`
     "FURB177", # Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups
+    "INP001",  # File declares a package, but is nested under an implicit namespace package.
     "N802",    # Function name should be lowercase
     "N806",    # Variable in function should be lowercase
     "PERF203", # `try`-`except` within a loop incurs performance overhead
@@ -267,10 +268,12 @@ ignore = [
     "PLW1641", # Object does not implement `__hash__` method
     "PTH100",  # `os.path.abspath()` should be replaced by `Path.resolve()`
     "PTH109",  # `os.getcwd()` should be replaced by `Path.cwd()`
+    "PYI061",  # [*] `Literal[None]` can be replaced with `None`
     "RET504",  # Unnecessary assignment to `data` before `return` statement
     "RUF005",  # Consider `[*path, str(key)]` instead of concatenation
     "RUF015",  # Prefer `next(iter(input_data["variables"].keys()))` over single element slice
     "RUF029",  # Function is declared `async`, but doesn't `await` or use `async` features.
+    "RUF056",  # [*] Avoid providing a falsy fallback to `dict.get()` in boolean test positions. The default fallback `None` is already falsy.
     "S108",    # Probable insecure usage of temporary file or directory
     "S311",    # Standard pseudo-random generators are not suitable for cryptographic purposes
     "S701",    # By default, jinja2 sets `autoescape` to `False`. Consider using `autoescape=True`
@@ -282,7 +285,7 @@ ignore = [
     "SIM117",  # Use a single `with` statement with multiple contexts instead of nested `with` statements
     "SIM118",  # Use `key in dict` instead of `key in dict.keys)
     "SIM910",  # Use `data.get(key)` instead of `data.get(key, None)`
-    "TCH003",  # Move standard library import `collections.abc.Iterable` into a type-checking block
+    "TC003",   # Move standard library import `collections.abc.Iterable` into a type-checking block
     "UP031",   # Use format specifiers instead of percent format
 ]
 

pyproject.toml

@@ -1680,6 +1680,12 @@ async def mock_query_corenode_page1_1(httpx_mock: HTTPXMock, client: InfrahubCli
     return httpx_mock
 
 
+@pytest.fixture
+async def mock_query_repository_count(httpx_mock: HTTPXMock, client: InfrahubClient, mock_schema_query_01) -> HTTPXMock:
+    httpx_mock.add_response(method="POST", json={"data": {"CoreRepository": {"count": 5}}})
+    return httpx_mock
+
+
 @pytest.fixture
 async def mock_query_repository_page1_empty(
     httpx_mock: HTTPXMock, client: InfrahubClient, mock_schema_query_01

tests/unit/sdk/conftest.py

@@ -73,6 +73,16 @@ async def test_get_repositories(
     }
 
 
+@pytest.mark.parametrize("client_type", client_types)
+async def test_method_count(clients, mock_query_repository_count, client_type):  # pylint: disable=unused-argument
+    if client_type == "standard":
+        count = await clients.standard.count(kind="CoreRepository")
+    else:
+        count = clients.sync.count(kind="CoreRepository")
+
+    assert count == 5
+
+
 @pytest.mark.parametrize("client_type", client_types)
 async def test_method_all_with_limit(clients, mock_query_repository_page1_2, client_type):  # pylint: disable=unused-argument
     if client_type == "standard":