Merge infrahub-develop into stable

.github/workflows/ci.yml

@@ -138,15 +138,15 @@ jobs:
         with:
           submodules: true
       - name: Install NodeJS
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v5
         with:
           node-version: 20
           cache: 'npm'
           cache-dependency-path: docs/package-lock.json
       - name: "Install dependencies"
         run: npm install
       - name: "Setup Python environment"
-        run: "pip install invoke toml"
+        run: "pip install invoke"
       - name: "Build docs website"
         run: "invoke docs"
 
@@ -176,7 +176,7 @@ jobs:
       - name: "Install dependencies"
         run: "poetry install --no-interaction --no-ansi --extras ctl"
       - name: "Setup environment"
-        run: "pip install invoke toml"
+        run: "poetry run pip install invoke"
       - name: "Validate generated documentation"
         run: "poetry run invoke docs-validate"
 
@@ -236,7 +236,11 @@ jobs:
         run: |
           pipx install poetry==${{ needs.prepare-environment.outputs.POETRY_VERSION }} --python python${{ matrix.python-version }}
           poetry config virtualenvs.create true --local
-          pip install invoke toml codecov
+          pip install invoke codecov
+      - name: "Install tomli for Python < 3.11"
+        if: matrix.python-version == '3.9' || matrix.python-version == '3.10'
+        run: |
+          pip install tomli
       - name: "Install Package"
         run: "poetry install --all-extras"
       - name: "Mypy Tests"
@@ -289,7 +293,7 @@ jobs:
         run: |
           pipx install poetry==${{ needs.prepare-environment.outputs.POETRY_VERSION }}
           poetry config virtualenvs.create true --local
-          pip install invoke toml codecov
+          pip install invoke codecov
       - name: "Install Package"
         run: "poetry install --all-extras"
       - name: "Integration Tests"
@@ -362,7 +366,7 @@ jobs:
   #       run: |
   #         pipx install poetry==${{ needs.prepare-environment.outputs.POETRY_VERSION }}
   #         poetry config virtualenvs.create true --local
-  #         pip install invoke toml codecov
+  #         pip install invoke codecov
 
   #     - name: "Install Package"
   #       run: "poetry install --all-extras"

.github/workflows/repository-dispatch.yml

@@ -45,7 +45,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Repository Dispatch
-        uses: peter-evans/repository-dispatch@v3
+        uses: peter-evans/repository-dispatch@v4
         with:
           token: ${{ secrets.GH_UPDATE_PACKAGE_OTTO }}
           # if matrix.repo contains a slash, use it literally; otherwise look up the secret named by matrix.repo

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.11.9
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format

.vale/styles/Infrahub/branded-terms-case-swap.yml

@@ -13,7 +13,6 @@ swap:
   (?:[Gg]itlab): GitLab
   (?:gitpod): GitPod
   (?:grafana): Grafana
-  (?:[^/][Gg]raphql): GraphQL
   (?:[Ii]nflux[Dd]b): InfluxDB
   infrahub(?:\s|$): Infrahub
   (?:jinja2): Jinja2

changelog/+branch-graph-version-status.added.md

@@ -0,0 +1 @@
+Add `graph_version` and `status` properties to `Branch`

changelog/+convert-object-type.added.md

@@ -0,0 +1 @@
+Add `convert_object_type` method to allow converting an object to another type.

changelog/+f6791a3d.added.md

@@ -0,0 +1 @@
+Added deprecation warnings when loading or checking schemas

changelog/+gql-command.added.md

@@ -0,0 +1 @@
+Add `infrahubctl graphql` commands to export schema and generate Pydantic types from GraphQL queries

changelog/380.fixed.md

@@ -0,0 +1 @@
+Replaced the `Sync` word in the protocol schema name so that the correct kind can be gotten from the cache

changelog/464.housekeeping.md

@@ -0,0 +1 @@
+Handle error gracefully when loading schema instead of failing with an exception

changelog/493.changed.md

@@ -0,0 +1 @@
+Deprecate the use of `raise_for_error=False` across several methods, using a try/except pattern is preferred.

changelog/528.housekeeping.md

@@ -0,0 +1 @@
+Replace toml package with tomllib and tomli optionally for when Python version is less than 3.11

changelog/560.added.md

@@ -0,0 +1 @@
+Add the ability to perform range expansions in object files. This feature allows users to define patterns in string fields that will be expanded into multiple objects, facilitating bulk object creation and management. The implementation includes validation to ensure that all expanded lists have the same length, preventing inconsistencies. Documentation has been updated to explain how to use this feature, including examples of valid and invalid configurations.

changelog/565.fixed.md

@@ -0,0 +1 @@
+Disable rich console print markup causing regex reformatting

docs/docs/infrahubctl/infrahubctl-graphql.mdx

@@ -0,0 +1,56 @@
+# `infrahubctl graphql`
+
+Various GraphQL related commands.
+
+**Usage**:
+
+```console
+$ infrahubctl graphql [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+
+* `export-schema`: Export the GraphQL schema to a file.
+* `generate-return-types`: Create Pydantic Models for GraphQL query...
+
+## `infrahubctl graphql export-schema`
+
+Export the GraphQL schema to a file.
+
+**Usage**:
+
+```console
+$ infrahubctl graphql export-schema [OPTIONS]
+```
+
+**Options**:
+
+* `--destination PATH`: Path to the GraphQL schema file.  [default: schema.graphql]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.
+
+## `infrahubctl graphql generate-return-types`
+
+Create Pydantic Models for GraphQL query return types
+
+**Usage**:
+
+```console
+$ infrahubctl graphql generate-return-types [OPTIONS] [QUERY]
+```
+
+**Arguments**:
+
+* `[QUERY]`: Location of the GraphQL query file(s). Defaults to current directory if not specified.
+
+**Options**:
+
+* `--schema PATH`: Path to the GraphQL schema file.  [default: schema.graphql]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.

docs/docs/python-sdk/guides/python-typing.mdx

@@ -100,4 +100,52 @@ from lib.protocols import MyOwnObject
 my_object = client.get(MyOwnObject, name__value="example")
 ```
 
-> if you don't have your own Python module, it's possible to use relative path by having the `procotols.py` in the same directory as your script/transform/generator
+> if you don't have your own Python module, it's possible to use relative path by having the `protocols.py` in the same directory as your script/transform/generator
+
+## Generating Pydantic models from GraphQL queries
+
+When working with GraphQL queries, you can generate type-safe Pydantic models that correspond to your query return types. This provides excellent type safety and IDE support for your GraphQL operations.
+
+### Why use generated return types?
+
+Generated Pydantic models from GraphQL queries offer several important benefits:
+
+- **Type Safety**: Catch type errors during development time instead of at runtime
+- **IDE Support**: Get autocomplete, type hints, and better IntelliSense in your IDE  
+- **Documentation**: Generated models serve as living documentation of your GraphQL API
+- **Validation**: Automatic validation of query responses against the expected schema
+
+### Generating return types
+
+Use the `infrahubctl graphql generate-return-types` command to create Pydantic models from your GraphQL queries:
+
+```shell
+# Generate models for queries in current directory
+infrahubctl graphql generate-return-types
+
+# Generate models for specific query files
+infrahubctl graphql generate-return-types queries/get_devices.gql
+```
+
+> You can also export the GraphQL schema first using the `infrahubctl graphql export-schema` command:
+
+### Example workflow
+
+1. **Create your GraphQL queries** in `.gql` files:
+
+2. **Generate the Pydantic models**:
+
+   ```shell
+   infrahubctl graphql generate-return-types queries/
+   ```
+
+   The command will generate the Python file per query based on the name of the query.
+
+3. **Use the generated models** in your Python code
+
+   ```python
+   from .queries.get_devices import GetDevicesQuery
+
+   response = await client.execute_graphql(query=MY_QUERY)
+   data = GetDevicesQuery(**response)
+   ```

docs/docs/python-sdk/topics/object_file.mdx

@@ -60,12 +60,24 @@ apiVersion: infrahub.app/v1
 kind: Object
 spec:
   kind: <NamespaceName>
+  parameters:
+    expand_range: <boolean>  # Optional, defaults to false
   data:
     - [...]
 ```
 
 > Multiple documents in a single YAML file are also supported, each document will be loaded separately. Documents are separated by `---`
 
+### Data Processing Parameters
+
+The `parameters` field controls how the data in the object file is processed before loading into Infrahub:
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `expand_range` | When set to `true`, range patterns (e.g., `[1-5]`) in string fields are expanded into multiple objects. | `false` |
+
+When `expand_range` is not specified, it defaults to `false`.
+
 ### Relationship of cardinality one
 
 A relationship of cardinality one can either reference an existing node via its HFID or create a new node if it doesn't exist.
@@ -195,3 +207,105 @@ Metadata support is planned for future releases. Currently, the Object file does
 2. Keep object files organized by model type or purpose.
 3. Validate object files before loading them into production environments.
 4. Use comments in your YAML files to document complex relationships or dependencies.
+
+## Range Expansion in Object Files
+
+The Infrahub Python SDK supports **range expansion** for string fields in object files when the `parameters > expand_range` is set to `true`. This feature allows you to specify a range pattern (e.g., `[1-5]`) in any string value, and the SDK will automatically expand it into multiple objects during validation and processing.
+
+```yaml
+---
+apiVersion: infrahub.app/v1
+kind: Object
+spec:
+  kind: BuiltinLocation
+  parameters:
+    expand_range: true  # Enable range expansion
+  data:
+    - name: AMS[1-3]
+      type: Country
+```
+
+### How Range Expansion Works
+
+- Any string field containing a pattern like `[1-5]`, `[10-15]`, or `[1,3,5]` will be expanded into multiple objects.
+- If multiple fields in the same object use range expansion, **all expanded lists must have the same length**. If not, validation will fail.
+- The expansion is performed before validation and processing, so all downstream logic works on the expanded data.
+
+### Examples
+
+#### Single Field Expansion
+
+```yaml
+spec:
+  kind: BuiltinLocation
+  parameters:
+    expand_range: true
+  data:
+    - name: AMS[1-3]
+      type: Country
+```
+
+This will expand to:
+
+```yaml
+- name: AMS1
+  type: Country
+- name: AMS2
+  type: Country
+- name: AMS3
+  type: Country
+```
+
+#### Multiple Field Expansion (Matching Lengths)
+
+```yaml
+spec:
+  kind: BuiltinLocation
+  parameters:
+    expand_range: true
+  data:
+    - name: AMS[1-3]
+      description: Datacenter [A-C]
+      type: Country
+```
+
+This will expand to:
+
+```yaml
+- name: AMS1
+  description: Datacenter A
+  type: Country
+- name: AMS2
+  description: Datacenter B
+  type: Country
+- name: AMS3
+  description: Datacenter C
+  type: Country
+```
+
+#### Error: Mismatched Range Lengths
+
+If you use ranges of different lengths in multiple fields:
+
+```yaml
+spec:
+  kind: BuiltinLocation
+  parameters:
+    expand_range: true
+  data:
+    - name: AMS[1-3]
+      description: "Datacenter [10-15]"
+      type: Country
+```
+
+This will **fail validation** with an error like:
+
+```bash
+Range expansion mismatch: fields expanded to different lengths: [3, 6]
+```
+
+### Notes
+
+- Range expansion is supported for any string field in the `data` section.
+- If no range pattern is present, the field is left unchanged.
+- If expansion fails for any field, validation will fail with an error message.

docs/docusaurus.config.ts

@@ -109,7 +109,7 @@ const config: Config = {
       additionalLanguages: ["bash", "python", "markup-templating", "django", "json", "toml", "yaml"],
     },
   } satisfies Preset.ThemeConfig,
-  
+
   markdown: {
     format: "mdx",
     preprocessor: ({ filePath, fileContent }) => {