infrahub-server 1.7.0b0__py3-none-any.whl → 1.7.1__py3-none-any.whl

infrahub_sdk/branch.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import warnings
 from enum import Enum
 from typing import TYPE_CHECKING, Any, Literal, overload
 from urllib.parse import urlencode
@@ -93,7 +92,6 @@ class InfrahubBranchManager(InfraHubBranchManagerBase):
         sync_with_git: bool = True,
         description: str = "",
         wait_until_completion: Literal[True] = True,
-        background_execution: bool | None = False,
     ) -> BranchData: ...
 
     @overload
@@ -103,7 +101,6 @@ class InfrahubBranchManager(InfraHubBranchManagerBase):
         sync_with_git: bool = True,
         description: str = "",
         wait_until_completion: Literal[False] = False,
-        background_execution: bool | None = False,
     ) -> str: ...
 
     async def create(
@@ -112,19 +109,9 @@ class InfrahubBranchManager(InfraHubBranchManagerBase):
         sync_with_git: bool = True,
         description: str = "",
         wait_until_completion: bool = True,
-        background_execution: bool | None = False,
     ) -> BranchData | str:
-        if background_execution is not None:
-            warnings.warn(
-                "`background_execution` is deprecated, please use `wait_until_completion` instead.",
-                DeprecationWarning,
-                stacklevel=1,
-            )
-
-        background_execution = background_execution or not wait_until_completion
         input_data = {
-            # Should be switched to `wait_until_completion` once `background_execution` is removed server side.
-            "background_execution": background_execution,
+            "wait_until_completion": wait_until_completion,
             "data": {
                 "name": branch_name,
                 "description": description,
@@ -132,15 +119,14 @@ class InfrahubBranchManager(InfraHubBranchManagerBase):
             },
         }
 
-        mutation_query = MUTATION_QUERY_TASK if background_execution else MUTATION_QUERY_DATA
+        mutation_query = MUTATION_QUERY_DATA if wait_until_completion else MUTATION_QUERY_TASK
         query = Mutation(mutation="BranchCreate", input_data=input_data, query=mutation_query)
         response = await self.client.execute_graphql(query=query.render(), tracker="mutation-branch-create")
 
-        # Make sure server version is recent enough to support background execution, as previously
-        # using background_execution=True had no effect.
-        if background_execution and "task" in response["BranchCreate"]:
-            return response["BranchCreate"]["task"]["id"]
-        return BranchData(**response["BranchCreate"]["object"])
+        if wait_until_completion:
+            return BranchData(**response["BranchCreate"]["object"])
+
+        return response["BranchCreate"]["task"]["id"]
 
     async def delete(self, branch_name: str) -> bool:
         input_data = {
@@ -261,7 +247,6 @@ class InfrahubBranchManagerSync(InfraHubBranchManagerBase):
         sync_with_git: bool = True,
         description: str = "",
         wait_until_completion: Literal[True] = True,
-        background_execution: bool | None = False,
     ) -> BranchData: ...
 
     @overload
@@ -271,7 +256,6 @@ class InfrahubBranchManagerSync(InfraHubBranchManagerBase):
         sync_with_git: bool = True,
         description: str = "",
         wait_until_completion: Literal[False] = False,
-        background_execution: bool | None = False,
     ) -> str: ...
 
     def create(
@@ -280,19 +264,9 @@ class InfrahubBranchManagerSync(InfraHubBranchManagerBase):
         sync_with_git: bool = True,
         description: str = "",
         wait_until_completion: bool = True,
-        background_execution: bool | None = False,
     ) -> BranchData | str:
-        if background_execution is not None:
-            warnings.warn(
-                "`background_execution` is deprecated, please use `wait_until_completion` instead.",
-                DeprecationWarning,
-                stacklevel=1,
-            )
-
-        background_execution = background_execution or not wait_until_completion
         input_data = {
-            # Should be switched to `wait_until_completion` once `background_execution` is removed server side.
-            "background_execution": background_execution,
+            "wait_until_completion": wait_until_completion,
             "data": {
                 "name": branch_name,
                 "description": description,
@@ -300,15 +274,14 @@ class InfrahubBranchManagerSync(InfraHubBranchManagerBase):
             },
         }
 
-        mutation_query = MUTATION_QUERY_TASK if background_execution else MUTATION_QUERY_DATA
+        mutation_query = MUTATION_QUERY_DATA if wait_until_completion else MUTATION_QUERY_TASK
         query = Mutation(mutation="BranchCreate", input_data=input_data, query=mutation_query)
         response = self.client.execute_graphql(query=query.render(), tracker="mutation-branch-create")
 
-        # Make sure server version is recent enough to support background execution, as previously
-        # using background_execution=True had no effect.
-        if background_execution and "task" in response["BranchCreate"]:
-            return response["BranchCreate"]["task"]["id"]
-        return BranchData(**response["BranchCreate"]["object"])
+        if wait_until_completion:
+            return BranchData(**response["BranchCreate"]["object"])
+
+        return response["BranchCreate"]["task"]["id"]
 
     def delete(self, branch_name: str) -> bool:
         input_data = {

infrahub_sdk/checks.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-import asyncio
 import importlib
-import os
+import inspect
+import pathlib
 import warnings
 from abc import abstractmethod
 from typing import TYPE_CHECKING, Any
@@ -55,7 +55,7 @@ class InfrahubCheck:
         self.branch = branch
         self.params = params or {}
 
-        self.root_directory = root_directory or os.getcwd()
+        self.root_directory = root_directory or str(pathlib.Path.cwd())
 
         self._client = client
 
@@ -160,7 +160,7 @@ class InfrahubCheck:
             data = await self.collect_data()
         unpacked = data.get("data") or data
 
-        if asyncio.iscoroutinefunction(self.validate):
+        if inspect.iscoroutinefunction(self.validate):
             await self.validate(data=unpacked)
         else:
             self.validate(data=unpacked)

infrahub_sdk/client.py

@@ -401,6 +401,7 @@ class InfrahubClient(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> SchemaType | None: ...
 
@@ -420,6 +421,7 @@ class InfrahubClient(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> SchemaType: ...
 
@@ -439,6 +441,7 @@ class InfrahubClient(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> SchemaType: ...
 
@@ -458,6 +461,7 @@ class InfrahubClient(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> InfrahubNode | None: ...
 
@@ -477,6 +481,7 @@ class InfrahubClient(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> InfrahubNode: ...
 
@@ -496,6 +501,7 @@ class InfrahubClient(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> InfrahubNode: ...
 
@@ -514,6 +520,7 @@ class InfrahubClient(BaseClient):
         fragment: bool = False,
         prefetch_relationships: bool = False,
         property: bool = False,
+        include_metadata: bool = False,
         **kwargs: Any,
     ) -> InfrahubNode | SchemaType | None:
         branch = branch or self.default_branch
@@ -547,6 +554,7 @@ class InfrahubClient(BaseClient):
             fragment=fragment,
             prefetch_relationships=prefetch_relationships,
             property=property,
+            include_metadata=include_metadata,
             **filters,
         )
 
@@ -650,6 +658,7 @@ class InfrahubClient(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
     ) -> list[SchemaType]: ...
 
     @overload
@@ -669,6 +678,7 @@ class InfrahubClient(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
     ) -> list[InfrahubNode]: ...
 
     async def all(
@@ -687,6 +697,7 @@ class InfrahubClient(BaseClient):
         property: bool = False,
         parallel: bool = False,
         order: Order | None = None,
+        include_metadata: bool = False,
     ) -> list[InfrahubNode] | list[SchemaType]:
         """Retrieve all nodes of a given kind
 
@@ -704,6 +715,7 @@ class InfrahubClient(BaseClient):
             prefetch_relationships (bool, optional): Flag to indicate whether to prefetch related node data.
             parallel (bool, optional): Whether to use parallel processing for the query.
             order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
+            include_metadata (bool, optional): If True, includes node_metadata and relationship_metadata in the query.
 
         Returns:
             list[InfrahubNode]: List of Nodes
@@ -723,6 +735,7 @@ class InfrahubClient(BaseClient):
             property=property,
             parallel=parallel,
             order=order,
+            include_metadata=include_metadata,
         )
 
     @overload
@@ -743,6 +756,7 @@ class InfrahubClient(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> list[SchemaType]: ...
 
@@ -764,6 +778,7 @@ class InfrahubClient(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> list[InfrahubNode]: ...
 
@@ -784,6 +799,7 @@ class InfrahubClient(BaseClient):
         property: bool = False,
         parallel: bool = False,
         order: Order | None = None,
+        include_metadata: bool = False,
         **kwargs: Any,
     ) -> list[InfrahubNode] | list[SchemaType]:
         """Retrieve nodes of a given kind based on provided filters.
@@ -803,6 +819,7 @@ class InfrahubClient(BaseClient):
             partial_match (bool, optional): Allow partial match of filter criteria for the query.
             parallel (bool, optional): Whether to use parallel processing for the query.
             order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
+            include_metadata (bool, optional): If True, includes node_metadata and relationship_metadata in the query.
             **kwargs (Any): Additional filter criteria for the query.
 
         Returns:
@@ -829,6 +846,7 @@ class InfrahubClient(BaseClient):
                 partial_match=partial_match,
                 property=property,
                 order=order,
+                include_metadata=include_metadata,
             )
             query = Query(query=query_data)
             response = await self.execute_graphql(
@@ -1957,6 +1975,7 @@ class InfrahubClientSync(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
     ) -> list[SchemaTypeSync]: ...
 
     @overload
@@ -1976,6 +1995,7 @@ class InfrahubClientSync(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
     ) -> list[InfrahubNodeSync]: ...
 
     def all(
@@ -1994,6 +2014,7 @@ class InfrahubClientSync(BaseClient):
         property: bool = False,
         parallel: bool = False,
         order: Order | None = None,
+        include_metadata: bool = False,
     ) -> list[InfrahubNodeSync] | list[SchemaTypeSync]:
         """Retrieve all nodes of a given kind
 
@@ -2011,6 +2032,7 @@ class InfrahubClientSync(BaseClient):
             prefetch_relationships (bool, optional): Flag to indicate whether to prefetch related node data.
             parallel (bool, optional): Whether to use parallel processing for the query.
             order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
+            include_metadata (bool, optional): If True, includes node_metadata and relationship_metadata in the query.
 
         Returns:
             list[InfrahubNodeSync]: List of Nodes
@@ -2030,6 +2052,7 @@ class InfrahubClientSync(BaseClient):
             property=property,
             parallel=parallel,
             order=order,
+            include_metadata=include_metadata,
         )
 
     def _process_nodes_and_relationships(
@@ -2091,6 +2114,7 @@ class InfrahubClientSync(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> list[SchemaTypeSync]: ...
 
@@ -2112,6 +2136,7 @@ class InfrahubClientSync(BaseClient):
         property: bool = ...,
         parallel: bool = ...,
         order: Order | None = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> list[InfrahubNodeSync]: ...
 
@@ -2132,6 +2157,7 @@ class InfrahubClientSync(BaseClient):
         property: bool = False,
         parallel: bool = False,
         order: Order | None = None,
+        include_metadata: bool = False,
         **kwargs: Any,
     ) -> list[InfrahubNodeSync] | list[SchemaTypeSync]:
         """Retrieve nodes of a given kind based on provided filters.
@@ -2151,6 +2177,7 @@ class InfrahubClientSync(BaseClient):
             partial_match (bool, optional): Allow partial match of filter criteria for the query.
             parallel (bool, optional): Whether to use parallel processing for the query.
             order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
+            include_metadata (bool, optional): If True, includes node_metadata and relationship_metadata in the query.
             **kwargs (Any): Additional filter criteria for the query.
 
         Returns:
@@ -2177,6 +2204,7 @@ class InfrahubClientSync(BaseClient):
                 partial_match=partial_match,
                 property=property,
                 order=order,
+                include_metadata=include_metadata,
             )
             query = Query(query=query_data)
             response = self.execute_graphql(
@@ -2266,6 +2294,7 @@ class InfrahubClientSync(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> SchemaTypeSync | None: ...
 
@@ -2285,6 +2314,7 @@ class InfrahubClientSync(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> SchemaTypeSync: ...
 
@@ -2304,6 +2334,7 @@ class InfrahubClientSync(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> SchemaTypeSync: ...
 
@@ -2323,6 +2354,7 @@ class InfrahubClientSync(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> InfrahubNodeSync | None: ...
 
@@ -2342,6 +2374,7 @@ class InfrahubClientSync(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> InfrahubNodeSync: ...
 
@@ -2361,6 +2394,7 @@ class InfrahubClientSync(BaseClient):
         fragment: bool = ...,
         prefetch_relationships: bool = ...,
         property: bool = ...,
+        include_metadata: bool = ...,
         **kwargs: Any,
     ) -> InfrahubNodeSync: ...
 
@@ -2379,6 +2413,7 @@ class InfrahubClientSync(BaseClient):
         fragment: bool = False,
         prefetch_relationships: bool = False,
         property: bool = False,
+        include_metadata: bool = False,
         **kwargs: Any,
     ) -> InfrahubNodeSync | SchemaTypeSync | None:
         branch = branch or self.default_branch
@@ -2412,6 +2447,7 @@ class InfrahubClientSync(BaseClient):
             fragment=fragment,
             prefetch_relationships=prefetch_relationships,
             property=property,
+            include_metadata=include_metadata,
             **filters,
         )
 

infrahub_sdk/ctl/cli_commands.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import asyncio
 import functools
 import importlib
+import inspect
 import logging
 import platform
 import sys
@@ -240,7 +241,7 @@ async def _run_transform(
                 console.print("[yellow]   you can specify a different branch with --branch")
         raise typer.Abort()
 
-    if asyncio.iscoroutinefunction(transform_func):
+    if inspect.iscoroutinefunction(transform_func):
         output = await transform_func(response)
     else:
         output = transform_func(response)

infrahub_sdk/ctl/graphql.py

@@ -22,7 +22,12 @@ from rich.console import Console
 from ..async_typer import AsyncTyper
 from ..ctl.client import initialize_client
 from ..ctl.utils import catch_exception
-from ..graphql.utils import insert_fragments_inline, remove_fragment_import
+from ..graphql.utils import (
+    insert_fragments_inline,
+    remove_fragment_import,
+    strip_typename_from_fragment,
+    strip_typename_from_operation,
+)
 from .parameters import CONFIG_PARAM
 
 app = AsyncTyper()
@@ -152,12 +157,18 @@ async def generate_return_types(
             queries = filter_operations_definitions(definitions)
             fragments = filter_fragments_definitions(definitions)
 
+            # Strip __typename fields from operations and fragments before code generation.
+            # __typename is a GraphQL introspection meta-field that isn't part of the schema's
+            # type definitions, causing ariadne-codegen to fail with "Redefinition of reserved type 'String'"
+            stripped_queries = [strip_typename_from_operation(q) for q in queries]
+            stripped_fragments = [strip_typename_from_fragment(f) for f in fragments]
+
             package_generator = get_package_generator(
                 schema=graphql_schema,
-                fragments=fragments,
+                fragments=stripped_fragments,
                 settings=ClientSettings(
                     schema_path=str(schema),
-                    target_package_name=directory.name,
+                    target_package_name=directory.name or "graphql_client",
                     queries_path=str(directory),
                     include_comments=CommentsStrategy.NONE,
                 ),
@@ -166,7 +177,7 @@ async def generate_return_types(
 
             parsing_failed = False
             try:
-                for query_operation in queries:
+                for query_operation in stripped_queries:
                     package_generator.add_operation(query_operation)
             except ParsingError as exc:
                 console.print(f"[red]Unable to process {gql_file.name}: {exc}")

infrahub_sdk/ctl/utils.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import asyncio
+import inspect
 import logging
 import traceback
 from collections.abc import Callable, Coroutine
@@ -83,7 +83,7 @@ def catch_exception(
         console = Console()
 
     def decorator(func: Callable[..., T]) -> Callable[..., T | Coroutine[Any, Any, T]]:
-        if asyncio.iscoroutinefunction(func):
+        if inspect.iscoroutinefunction(func):
 
             @wraps(func)
             async def async_wrapper(*args: Any, **kwargs: Any) -> T:

infrahub_sdk/enums.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class OrderDirection(str, Enum):
+    ASC = "ASC"
+    DESC = "DESC"

infrahub_sdk/graphql/renderers.py

@@ -7,6 +7,8 @@ from typing import Any
 
 from pydantic import BaseModel
 
+from infrahub_sdk.types import Order
+
 from .constants import VARIABLE_TYPE_MAPPING
 
 
@@ -53,6 +55,16 @@ def convert_to_graphql_as_string(value: Any, convert_enum: bool = False) -> str:
     if isinstance(value, list):
         values_as_string = [convert_to_graphql_as_string(value=item, convert_enum=convert_enum) for item in value]
         return "[" + ", ".join(values_as_string) + "]"
+    if isinstance(value, Order):
+        data = value.model_dump(exclude_none=True)
+        return (
+            "{ "
+            + ", ".join(
+                f"{key}: {convert_to_graphql_as_string(value=val, convert_enum=convert_enum)}"
+                for key, val in data.items()
+            )
+            + " }"
+        )
     if isinstance(value, BaseModel):
         data = value.model_dump()
         return (
@@ -63,6 +75,15 @@ def convert_to_graphql_as_string(value: Any, convert_enum: bool = False) -> str:
             )
             + " }"
         )
+    if isinstance(value, dict):
+        return (
+            "{ "
+            + ", ".join(
+                f"{key}: {convert_to_graphql_as_string(value=val, convert_enum=convert_enum)}"
+                for key, val in value.items()
+            )
+            + " }"
+        )
 
     return str(value)
 

infrahub_sdk/graphql/utils.py

@@ -1,5 +1,90 @@
 import ast
 
+from graphql import (
+    FieldNode,
+    FragmentDefinitionNode,
+    FragmentSpreadNode,
+    InlineFragmentNode,
+    OperationDefinitionNode,
+    SelectionNode,
+    SelectionSetNode,
+)
+
+
+def strip_typename_from_selection_set(selection_set: SelectionSetNode | None) -> SelectionSetNode | None:
+    """Recursively strip __typename fields from a SelectionSetNode.
+
+    The __typename meta-field is an introspection field that is not part of the schema's
+    type definitions. When code generation tools like ariadne-codegen try to look up
+    __typename in the schema, they fail because it's a reserved introspection field.
+
+    This function removes all __typename fields from the selection set, allowing
+    code generation to proceed without errors.
+    """
+    if selection_set is None:
+        return None
+
+    new_selections: list[SelectionNode] = []
+    for selection in selection_set.selections:
+        if isinstance(selection, FieldNode):
+            # Skip __typename fields
+            if selection.name.value == "__typename":
+                continue
+            # Recursively process nested selection sets
+            new_field = FieldNode(
+                alias=selection.alias,
+                name=selection.name,
+                arguments=selection.arguments,
+                directives=selection.directives,
+                selection_set=strip_typename_from_selection_set(selection.selection_set),
+            )
+            new_selections.append(new_field)
+        elif isinstance(selection, InlineFragmentNode):
+            # Process inline fragments
+            new_inline = InlineFragmentNode(
+                type_condition=selection.type_condition,
+                directives=selection.directives,
+                selection_set=strip_typename_from_selection_set(selection.selection_set),
+            )
+            new_selections.append(new_inline)
+        elif isinstance(selection, FragmentSpreadNode):
+            # FragmentSpread references a named fragment - keep as-is
+            new_selections.append(selection)
+        else:
+            raise TypeError(f"Unexpected GraphQL selection node type '{type(selection).__name__}'.")
+
+    return SelectionSetNode(selections=tuple(new_selections))
+
+
+def strip_typename_from_operation(operation: OperationDefinitionNode) -> OperationDefinitionNode:
+    """Strip __typename fields from an operation definition.
+
+    Returns a new OperationDefinitionNode with all __typename fields removed
+    from its selection set and any nested selection sets.
+    """
+    return OperationDefinitionNode(
+        operation=operation.operation,
+        name=operation.name,
+        variable_definitions=operation.variable_definitions,
+        directives=operation.directives,
+        selection_set=strip_typename_from_selection_set(operation.selection_set),
+    )
+
+
+def strip_typename_from_fragment(fragment: FragmentDefinitionNode) -> FragmentDefinitionNode:
+    """Strip __typename fields from a fragment definition.
+
+    Returns a new FragmentDefinitionNode with all __typename fields removed
+    from its selection set and any nested selection sets.
+    """
+    return FragmentDefinitionNode(
+        name=fragment.name,
+        type_condition=fragment.type_condition,
+        variable_definitions=fragment.variable_definitions,
+        directives=fragment.directives,
+        selection_set=strip_typename_from_selection_set(fragment.selection_set),
+    )
+
 
 def get_class_def_index(module: ast.Module) -> int:
     """Get the index of the first class definition in the module.