Lint Python files using ruff

Author: dflook

.config/ruff.toml

@@ -0,0 +1,29 @@
+line-length = 120
+
+target-version = "py39"
+
+src = ["docs-gen", "image/src"]
+
+include = [
+    "docs-gen/*.py",
+    "image/src/*.py",
+    "image/src/setup.py",
+    "tools/*.py",
+]
+
+[lint]
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[lint.flake8-quotes]
+inline-quotes = "single"
+multiline-quotes = "single"
+docstring-quotes = "double"
+
+[format]
+quote-style = "single"
+docstring-code-format = true

.github/workflows/test.yaml

@@ -148,3 +148,7 @@ jobs:
           yamllint -c .config/.yamllint.yaml .
 
           V8R_CONFIG_FILE=.config/.v8rrc.yaml npx v8r --ignore-errors
+
+      - uses: astral-sh/ruff-action@9828f49eb4cadf267b40eaa330295c412c68c1f9 # v3
+        with:
+          args: --config=.config/ruff.toml check

.gitignore

@@ -4,3 +4,8 @@
 /venv/
 .terraform.lock.hcl
 .terraform-bin-dir/
+.gpg/
+build/
+__pycache__/
+.DS_Store
+*.egg-info/

docs-gen/action.py

@@ -1,5 +1,6 @@
 import textwrap
-from dataclasses import dataclass, field
+import dataclasses
+from dataclasses import dataclass
 from textwrap import indent
 from typing import Callable, Type
 
@@ -93,9 +94,9 @@ class Output:
     description: str
     meta_description: str = None
     type: str = None
-    aliases: list[str] = field(default_factory=list)
+    aliases: list[str] = dataclasses.field(default_factory=list)
     meta_output: bool = False
-    available_in: list[Type[Terraform] | Type[OpenTofu]] = field(default_factory=lambda: [Terraform, OpenTofu])
+    available_in: list[Type[Terraform] | Type[OpenTofu]] = dataclasses.field(default_factory=lambda: [Terraform, OpenTofu])
 
     def markdown(self, tool: Tool) -> str:
         if self.meta_output:
@@ -135,11 +136,11 @@ class Action:
     name: str
     description: str | Callable[[Tool], str]
     meta_description: str = None
-    inputs: list[Input] = field(default_factory=list)
+    inputs: list[Input] = dataclasses.field(default_factory=list)
     inputs_intro: str = None
     environment_variables: list[EnvVar] = None
     environment_variables_intro: str = None
-    outputs: list[Output] = field(default_factory=list)
+    outputs: list[Output] = dataclasses.field(default_factory=list)
     outputs_intro: str = None
     extra: str | Callable[[bool], str] = None
 
@@ -318,4 +319,4 @@ def action_yaml(self, tool: Tool) -> str:
                   color: purple
             ''', trailing_blank_line=False)
 
-        return productize(s, tool)
+        return productize(s, tool)

docs-gen/actions/new_workspace.py

@@ -2,7 +2,6 @@
 
 from action import Action
 from environment_variables.GITHUB_DOT_COM_TOKEN import GITHUB_DOT_COM_TOKEN
-from environment_variables.TERRAFORM_ACTIONS_GITHUB_TOKEN import TERRAFORM_ACTIONS_GITHUB_TOKEN
 from environment_variables.TERRAFORM_CLOUD_TOKENS import TERRAFORM_CLOUD_TOKENS
 from environment_variables.TERRAFORM_HTTP_CREDENTIALS import TERRAFORM_HTTP_CREDENTIALS
 from environment_variables.TERRAFORM_PRE_RUN import TERRAFORM_PRE_RUN

docs-gen/actions/remote_state.py

@@ -6,7 +6,6 @@
 from inputs.backend_config import backend_config
 from inputs.backend_config_file import backend_config_file
 from inputs.backend_type import backend_type
-from inputs.path import path
 from inputs.workspace import workspace
 from outputs.terraform_outputs import terraform_outputs
 

image/src/github_pr_comment/__main__.py

@@ -151,9 +151,9 @@ def format_description(action_inputs: PlanPrInputs, sensitive_variables: List[st
         label += f'\nWith backend config files: `{action_inputs["INPUT_BACKEND_CONFIG_FILE"]}`'
 
     if action_inputs["INPUT_VAR"]:
-        label += f'\n:warning: Using deprecated var input. Use the variables input instead.'
+        label += '\n:warning: Using deprecated var input. Use the variables input instead.'
         if any(var_name in action_inputs["INPUT_VAR"] for var_name in sensitive_variables):
-            label += f'\nWith vars: (sensitive values)'
+            label += '\nWith vars: (sensitive values)'
         else:
             label += f'\nWith vars: `{action_inputs["INPUT_VAR"]}`'
 
@@ -226,7 +226,7 @@ def graphql() -> Optional[str]:
         if response.ok:
             try:
                 return response.json()['data']['viewer']['login']
-            except Exception as e:
+            except Exception:
                 pass
 
         debug('Failed to get current user from graphql')

image/src/plan_renderer/variables.py

@@ -2,7 +2,8 @@
 from textwrap import indent
 
 
-class Sensitive: pass
+class Sensitive:
+    pass
 
 
 def render_argument_list(argument_list: dict[str, Any]) -> str:

image/src/terraform/hcl.py

@@ -31,7 +31,7 @@ def is_loadable(path: Path) -> bool:
         debug('TimeoutExpired')
         # We found a file that won't parse :(
         return False
-    except:
+    except Exception:
         # If we get an exception, we can still try and load it.
         return True
 
@@ -55,8 +55,8 @@ def loads(hcl: str) -> dict:
     if is_loadable(tmp_path):
         return hcl2.loads(hcl)
 
-    debug(f'Unable to load hcl')
-    raise ValueError(f'Unable to load hcl')
+    debug('Unable to load hcl')
+    raise ValueError('Unable to load hcl')
 
 
 if __name__ == '__main__':

image/src/terraform/module.py

@@ -152,8 +152,8 @@ def get_remote_backend_config(
         'workspaces': {}
     })
 
-    for terraform in module.get('terraform', []):
-        for backend in terraform.get('backend', []):
+    for terraform_block in module.get('terraform', []):
+        for backend in terraform_block.get('backend', []):
             if 'remote' not in backend:
                 return None
 
@@ -209,8 +209,8 @@ def get_cloud_config(module: TerraformModule, cli_config_path: Path) -> Optional
         'workspaces': {}
     })
 
-    for terraform in module.get('terraform', []):
-        for cloud in terraform.get('cloud', []):
+    for terraform_block in module.get('terraform', []):
+        for cloud in terraform_block.get('cloud', []):
 
             found = True
 
@@ -245,13 +245,13 @@ def get_backend_type(module: TerraformModule) -> Optional[str]:
     :return: The name of the backend used by the module
     """
 
-    for terraform in module.get('terraform', []):
-        for backend in terraform.get('backend', []):
+    for terraform_block in module.get('terraform', []):
+        for backend in terraform_block.get('backend', []):
             for backend_type in backend:
                 return str(backend_type)
 
-    for terraform in module.get('terraform', []):
-        if 'cloud' in terraform:
+    for terraform_block in module.get('terraform', []):
+        if 'cloud' in terraform_block:
             return 'cloud'
 
     return 'local'