fix typing

Author: gruebel

cloudsplaining/command/create_multi_account_config_file.py

@@ -42,14 +42,16 @@ def create_multi_account_config_file(output_file: str, verbosity: int) -> None:
     """
     set_log_level(verbosity)
 
-    output_file = Path(output_file)
-    if output_file.exists():
-        logger.debug("%s exists. Removing the file and replacing its contents.", output_file)
-        output_file.unlink()
+    output_file_path = Path(output_file)
+    if output_file_path.exists():
+        logger.debug("%s exists. Removing the file and replacing its contents.", output_file_path)
+        output_file_path.unlink()
 
-    with output_file.open("a", encoding="utf-8") as file_obj:
+    with output_file_path.open("a", encoding="utf-8") as file_obj:
         file_obj.write(MULTI_ACCOUNT_CONFIG_TEMPLATE)
 
-    utils.print_green(f"Success! Multi-account config file written to: {output_file}")
-    print(f"\nMake sure you edit the {output_file} file and then run the scan-multi-account command, as shown below.")
-    print(f"\n\tcloudsplaining scan-multi-account --exclusions-file exclusions.yml -c {output_file} -o ./")
+    utils.print_green(f"Success! Multi-account config file written to: {output_file_path}")
+    print(
+        f"\nMake sure you edit the {output_file_path} file and then run the scan-multi-account command, as shown below."
+    )
+    print(f"\n\tcloudsplaining scan-multi-account --exclusions-file exclusions.yml -c {output_file_path} -o ./")

cloudsplaining/command/download.py

@@ -62,12 +62,12 @@ def download(profile: str, output: str, include_non_default_policy_versions: boo
     default_region = "us-east-1"
     session_data = {"region_name": default_region}
 
-    output = Path(output)
+    output_path = Path(output)
     if profile:
         session_data["profile_name"] = profile
-        output_filename = output / f"{profile}.json"
+        output_filename = output_path / f"{profile}.json"
     else:
-        output_filename = output / "default.json"
+        output_filename = output_path / "default.json"
 
     results = get_account_authorization_details(session_data, include_non_default_policy_versions)
     with output_filename.open("w", encoding="utf-8") as f:

cloudsplaining/command/scan.py

@@ -139,24 +139,24 @@ def scan(
         flag_conditional_statements = False
         flag_resource_arn_statements = False
 
-    output = Path(output)
-    input_file = Path(input_file)
-    if input_file.is_file():
-        account_name = input_file.stem
-        account_authorization_details_cfg = json.loads(input_file.read_text(encoding="utf-8"))
+    output_path = Path(output)
+    input_file_path = Path(input_file)
+    if input_file_path.is_file():
+        account_name = input_file_path.stem
+        account_authorization_details_cfg = json.loads(input_file_path.read_text(encoding="utf-8"))
         rendered_html_report = scan_account_authorization_details(
             account_authorization_details_cfg,
             exclusions,
             account_name,
-            output,
+            output_path,
             write_data_files=True,
             minimize=minimize,
             flag_conditional_statements=flag_conditional_statements,
             flag_resource_arn_statements=flag_resource_arn_statements,
             flag_trust_policies=flag_trust_policies,
             severity=severity,
         )
-        html_output_file = output / f"iam-report-{account_name}.html"
+        html_output_file = output_path / f"iam-report-{account_name}.html"
         logger.info("Saving the report to %s", html_output_file)
         if html_output_file.exists():
             html_output_file.unlink()
@@ -171,25 +171,25 @@ def scan(
             url = f"file://{html_output_file.absolute()}"
             webbrowser.open(url, new=2)
 
-    if input_file.is_dir():
+    if input_file_path.is_dir():
         logger.info("The path given is a directory. Scanning for account authorization files and generating report.")
-        input_files = get_authorization_files_in_directory(input_file)
+        input_files = get_authorization_files_in_directory(input_file_path)
         for file in input_files:
             logger.info(f"Scanning file: {file}")
             account_authorization_details_cfg = json.loads(Path(file).read_text(encoding="utf-8"))
 
-            account_name = input_file.parent.stem
+            account_name = input_file_path.parent.stem
             # Scan the Account Authorization Details config
             rendered_html_report = scan_account_authorization_details(
                 account_authorization_details_cfg,
                 exclusions,
                 account_name,
-                output,
+                output_path,
                 write_data_files=True,
                 minimize=minimize,
                 severity=severity,
             )
-            html_output_file = output / f"iam-report-{account_name}.html"
+            html_output_file = output_path / f"iam-report-{account_name}.html"
             logger.info("Saving the report to %s", html_output_file)
             if html_output_file.exists():
                 html_output_file.unlink()

cloudsplaining/command/scan_multi_account.py

@@ -227,13 +227,13 @@ def scan_accounts(
                 utils.print_green(f"Saved the JSON data to: s3://{output_bucket}/{output_file}")
         if output_directory:
             # Write the HTML file
-            output_directory = Path(output_directory)
-            html_output_file = output_directory / f"{target_account_name}.html"
+            output_dir_path = Path(output_directory)
+            html_output_file = output_dir_path / f"{target_account_name}.html"
             utils.write_file(html_output_file, rendered_report)
             utils.print_green(f"Saved the HTML report to: {html_output_file}")
             # Write the JSON data file
             if write_data_file:
-                results_data_file = output_directory / f"{target_account_name}.json"
+                results_data_file = output_dir_path / f"{target_account_name}.json"
                 results_data_filepath = utils.write_results_data_file(results, results_data_file)
                 utils.print_green(f"Saved the JSON data to: {results_data_filepath}")
 

cloudsplaining/shared/template_config.py

@@ -26,12 +26,12 @@ def _get_custom_content(self, filename: str) -> str:
         if not filename or "/" in filename or "\\" in filename or ".." in filename:
             return "default"
 
-        filename = Path(filename)
-        if not filename.exists():
+        file_path = Path(filename)
+        if not file_path.exists():
             return "default"
 
         try:
-            content = filename.read_text(encoding="utf-8").strip()
+            content = file_path.read_text(encoding="utf-8").strip()
             if content:
                 json_str = json.dumps(content)
                 return json_str[1:-1]

cloudsplaining/shared/utils.py

@@ -119,7 +119,7 @@ def is_aws_managed(arn: str) -> bool:
 
 
 # pragma: no cover
-def write_results_data_file(results: dict[str, dict[str, Any]], raw_data_file: Path) -> str:
+def write_results_data_file(results: dict[str, dict[str, Any]], raw_data_file: Path) -> Path:
     """
     Writes the raw data file containing all the results for an AWS account