infrablocks.terraform_pkl_type_gen 0.0.1__tar.gz

infrablocks_terraform_pkl_type_gen-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 InfraBlocks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

infrablocks_terraform_pkl_type_gen-0.0.1/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2025 InfraBlocks Maintainers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

infrablocks_terraform_pkl_type_gen-0.0.1/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: infrablocks.terraform_pkl_type_gen
+Version: 0.0.1
+Summary: Provides invoke tasks to interact with terraform
+License: MIT
+Author: Toby Clemson
+Author-email: tobyclemson@gmail.com
+Requires-Python: >=3.13,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Dist: infrablocks-invoke-factory (>=0.0.3a6,<0.0.4)
+Requires-Dist: invoke (>=2.2.0,<3.0.0)
+Requires-Dist: tfparse (>=0.6.16,<0.7.0)
+Description-Content-Type: text/markdown
+
+# Terraform Pkl Type Gen
+
+A library for creating Pkl types from Terraform variables definitions.
+
+## Development
+
+For the best developer experience make sure you have `direnv` and `asdf` installed.
+
+Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/infrablocks/terraform_pkl_type_gen.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+Contributor Covenant code of conduct.
+
+License
+Copyright © 2025 InfraBlocks Maintainers
+
+Distributed under the terms of the MIT License.

infrablocks_terraform_pkl_type_gen-0.0.1/README.md

@@ -0,0 +1,17 @@
+# Terraform Pkl Type Gen
+
+A library for creating Pkl types from Terraform variables definitions.
+
+## Development
+
+For the best developer experience make sure you have `direnv` and `asdf` installed.
+
+Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/infrablocks/terraform_pkl_type_gen.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+Contributor Covenant code of conduct.
+
+License
+Copyright © 2025 InfraBlocks Maintainers
+
+Distributed under the terms of the MIT License.

infrablocks_terraform_pkl_type_gen-0.0.1/pyproject.toml

@@ -0,0 +1,131 @@
+[project]
+requires-python = ">=3.13,<4.0"
+
+[tool.poetry]
+name = "infrablocks.terraform_pkl_type_gen"
+version = "0.0.1"
+description = "Provides invoke tasks to interact with terraform"
+authors = [
+    "Toby Clemson <tobyclemson@gmail.com>",
+    "Tom Duckering <tom.duckering@gmail.com>",
+]
+license = "MIT"
+readme = "README.md"
+packages = [
+    { include = "infrablocks", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = ">=3.13,<4.0"
+invoke = "^2.2.0"
+infrablocks-invoke-factory = {version = "^0.0.3a6", allow-prereleases = true}
+tfparse = "^0.6.16"
+
+[tool.poetry.group.dev.dependencies]
+coverage = "^7.6.10"
+junitparser = "^3.2.0"
+poethepoet = "^0.33.1"
+pyright = { extras = ["nodejs"], version = "^1.1.391" }
+pytest = "^8.3.4"
+pytest-asyncio = "^0.25.1"
+pytest-cov = "^6.0.0"
+pytest-diff = "^0.1.14"
+pytest-pretty = "^1.2.0"
+pytest-repeat = "^0.9.3"
+pytest-unordered = "^0.6.1"
+ruff = "^0.11.0"
+
+[tool.poetry.group.changelog.dependencies]
+scriv = "^1.5.1"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs-material = "^9.5.47"
+mkdocstrings = { extras = ["python"], version = "^0.29.0" }
+black = "^25.1.0"
+
+[tool.poe.tasks]
+lint-check = "ruff check src tests"
+lint-fix = "ruff check --fix src tests"
+format-check = "ruff format --diff src tests"
+format-fix = "ruff format src tests"
+type-check = "pyright src tests"
+docs-serve = "mkdocs serve"
+docs-build = "mkdocs build"
+changelog-fragment-create = "scriv create"
+changelog-assemble = "scriv collect"
+
+[tool.poe.tasks.test-unit]
+args = [{ name = "filter", options = ["--filter"], default = "" }]
+shell = """
+  mkdir -p reports/coverage/unit
+  pytest -vv tests/unit \
+    --junitxml=./reports/unit.junit.xml \
+    --cov-report=xml:./reports/coverage/unit/coverage.xml \
+    --cov-report=html:./reports/coverage/unit \
+    ${filter:+-k ${filter}}
+"""
+
+[tool.poe.tasks.test-unit.env]
+COVERAGE_FILE = "./reports/coverage/unit/.coverage"
+PYTHONDEVMODE = "1"
+
+[tool.poe.tasks.test-report]
+shell = """
+  junitparser merge \
+    reports/*.junit.xml \
+    reports/all.junit.xml
+  coverage combine \
+    --keep \
+    --data-file=./reports/coverage/.coverage \
+    reports/coverage/unit/.coverage
+  coverage html \
+    --data-file=./reports/coverage/.coverage \
+    --directory=./reports/coverage/all
+  coverage xml \
+    --data-file=./reports/coverage/.coverage \
+    -o ./reports/coverage/all/coverage.xml
+  coverage report \
+    --data-file=./reports/coverage/.coverage
+"""
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = [
+    "--import-mode=importlib",
+    "--strict-markers",
+    "--capture=no",
+    "--cov=./src"
+]
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+exclude_also = ["@abstract"]
+
+[tool.ruff]
+line-length = 79
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "I"]
+
+[tool.ruff.lint.pylint]
+max-args = 7
+allow-magic-value-types = ["str", "bytes", "int"]
+
+[tool.pyright]
+include = ["src", "tests/unit"]
+extraPaths = ["src"]
+strict = ["src"]
+reportMissingTypeStubs = "error"
+
+[tool.scriv]
+version = "literal: pyproject.toml: tool.poetry.version"
+format = "md"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

infrablocks_terraform_pkl_type_gen-0.0.1/src/infrablocks/terraform_pkl_type_gen/__init__.py

@@ -0,0 +1,3 @@
+from .pkl_generator import generate_pkl_type as generate_pkl_type
+from .pkl_generator import map_type as map_type
+from .pkl_generator import write_pkl_type as write_pkl_type

infrablocks_terraform_pkl_type_gen-0.0.1/src/infrablocks/terraform_pkl_type_gen/pkl_generator.py

@@ -0,0 +1,56 @@
+from typing import Dict, List
+
+from tfparse import load_from_path
+
+type_mapping: Dict[str, str] = {
+    "string": "String",
+    "number": "Number",
+    "bool": "Boolean",
+    "list of dynamic": "Listing",
+    "list(any)": "Listing",
+    "list of string": "Listing<String>",
+    "list of number": "Listing<Number>",
+    "list of bool": "Listing<Boolean>",
+    "map of dynamic": "Mapping<String, Any>",
+    "map of string": "Mapping<String, String>",
+    "map of number": "Mapping<String, Number>",
+    "map of bool": "Mapping<String, Boolean>",
+}
+
+indent = "  "
+
+
+def map_type(terraform_type: str) -> str:
+    """Map Terraform type to Python type."""
+    return type_mapping[terraform_type]
+
+
+def generate_pkl_type(chdir: str, type_name: str) -> str:
+    parsed = load_from_path(chdir)
+    root_variables = [
+        variable
+        for variable in parsed["variable"]
+        if variable["__tfmeta"]["filename"] == "variables.tf"
+    ]
+    output: List[str] = []
+
+    output.append(
+        f"// This file is automatically generated based on the input variables in {chdir}/variables.tf"
+    )
+    output.append(f"class {type_name} {{")
+
+    for variable in root_variables:
+        output.append(
+            f"{indent}{variable['__tfmeta']['label']}: {map_type(variable['type'])}"
+        )
+
+    output.append("}")
+    return "\n".join(output)
+
+
+def write_pkl_type(chdir: str, target_file_path: str, type_name: str) -> None:
+    """Generate and write the PKL type to a file."""
+    result = generate_pkl_type(chdir, type_name)
+
+    with open(target_file_path, "w") as file:
+        file.write(result)