IFC-1811: Replace toml package with tomllib and tomli optionally (#551)

* Replace toml package with tomllib and tomli optionally

* fix for mypy errors

* update config, add pre-commit config

* Make tomli package optional

* Add towncrier housekeeping message

* update python to uppercase p

Author: solababs

.github/workflows/ci.yml

@@ -146,7 +146,7 @@ jobs:
       - 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"

.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

changelog/528.housekeeping.md

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

docs/docusaurus.config.ts

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

infrahub_sdk/ctl/config.py

@@ -2,13 +2,18 @@
 
 from __future__ import annotations
 
+import sys
 from pathlib import Path
 
-import toml
 import typer
 from pydantic import Field, ValidationError, field_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
+if sys.version_info >= (3, 11):
+    import tomllib
+else:
+    import tomli as tomllib
+
 DEFAULT_CONFIG_FILE = "infrahubctl.toml"
 ENVVAR_CONFIG_FILE = "INFRAHUBCTL_CONFIG"
 INFRAHUB_REPO_CONFIG_FILE = ".infrahub.yml"
@@ -59,7 +64,7 @@ def load(self, config_file: str | Path = "infrahubctl.toml", config_data: dict |
 
         if config_file.is_file():
             config_string = config_file.read_text(encoding="utf-8")
-            config_tmp = toml.loads(config_string)
+            config_tmp = tomllib.loads(config_string)
 
             self._settings = Settings(**config_tmp)
             return