Updates, as recommend in PR review.

peter-smith-phd · peter-smith-phd · commit 806a1d58170d · 2026-01-06T04:12:46.000+13:00
diff --git a/localstack-core/localstack/services/cloudformation/scaffolding/__main__.py b/localstack-core/localstack/services/cloudformation/scaffolding/__main__.py
@@ -2,6 +2,8 @@
 
 import json
 import os
+import subprocess
+import sys
 import zipfile
 from collections.abc import Generator
 from dataclasses import dataclass
@@ -353,12 +355,7 @@ def render(
                         resource_name, FileType.attribute_template, tests_output_path, pro=self.pro
                     )
                 )
-            case FileType.provider:
-                kwargs["service"] = resource_name.python_compatible_service_name.lower()
-                kwargs["lower_resource"] = resource_name.resource.lower()
-                kwargs["pro"] = self.pro
-                pass
-            case FileType.provider_base:
+            case FileType.provider | FileType.provider_base:
                 property_ir = generate_ir_for_type(
                     [self.schema],
                     resource_name.full_name,
@@ -384,6 +381,9 @@ def render(
                 kwargs["list_permissions"] = (
                     self.schema.get("handlers", {}).get("list", {}).get("permissions")
                 )
+                kwargs["service"] = resource_name.python_compatible_service_name.lower()
+                kwargs["lower_resource"] = resource_name.resource.lower()
+                kwargs["pro"] = self.pro
             case FileType.plugin:
                 kwargs["service"] = resource_name.python_compatible_service_name.lower()
                 kwargs["lower_resource"] = resource_name.resource.lower()
@@ -728,13 +728,25 @@ def confirm_overwrite(self, destination_file: Path) -> bool:
 
         :return True if file should be (over-)written, False otherwise
         """
-        return self.overwrite or click.confirm("Destination files already exist, overwrite?")
+        return self.overwrite or click.confirm(
+            f"Destination file {destination_file} already exists, overwrite?"
+        )
 
     @staticmethod
     def write_text(contents: str, destination: Path):
         with destination.open("wt") as outfile:
             print(contents, file=outfile)
 
+        # for Python files, use ruff to clean up formatting errors introduced by scaffolding
+        if destination.suffix == ".py":
+            command = [sys.executable, "-m", "ruff", "format", destination]
+            try:
+                subprocess.run(command, check=True, capture_output=True, text=True)
+            except subprocess.CalledProcessError as e:
+                print(
+                    f"Ruff fix command failed (exit code {e.returncode}):\n{e.stdout}\n{e.stderr}"
+                )
+
     @staticmethod
     def ensure_python_init_files(path: Path):
         """
diff --git a/localstack-core/localstack/services/cloudformation/scaffolding/templates/provider_base_template.py.j2 b/localstack-core/localstack/services/cloudformation/scaffolding/templates/provider_base_template.py.j2
@@ -121,3 +121,19 @@ class {{ resource }}ProviderBase(ResourceProvider[{{ resource }}Properties], ABC
         {%- endif %}
         """
         raise NotImplementedError
+
+    @abstractmethod
+    def list(
+        self,
+        request: ResourceRequest[{{ resource }}Properties],
+    ) -> ProgressEvent[{{ resource }}Properties]:
+        """
+        List available resources of this type
+        {% if list_permissions -%}
+        IAM permissions required:
+        {%- for permission in list_permissions %}
+          - {{ permission }}
+        {%- endfor %}
+        {%- endif %}
+        """
+        raise NotImplementedError
diff --git a/localstack-core/localstack/services/cloudformation/scaffolding/templates/provider_template.py.j2 b/localstack-core/localstack/services/cloudformation/scaffolding/templates/provider_template.py.j2
@@ -22,6 +22,44 @@ class {{ resource }}Provider({{ resource }}ProviderBase):
         self,
         request: ResourceRequest[{{ resource }}Properties],
     ) -> ProgressEvent[{{ resource }}Properties]:
+        """
+        Create a new resource.
+
+        {% if primary_identifier -%}
+        Primary identifier fields:
+        {%- for property in primary_identifier %}
+          - {{ property }}
+        {%- endfor %}
+        {%- endif %}
+
+        {% if required_properties -%}
+        Required properties:
+        {%- for property in required_properties %}
+          - {{ property }}
+        {%- endfor %}
+        {%- endif %}
+
+        {% if create_only_properties -%}
+        Create-only properties:
+        {%- for property in create_only_properties %}
+          - {{ property }}
+        {%- endfor %}
+        {%- endif %}
+
+        {% if read_only_properties -%}
+        Read-only properties:
+        {%- for property in read_only_properties %}
+          - {{ property }}
+        {%- endfor %}
+        {%- endif %}
+
+        {% if create_permissions -%}
+        IAM permissions required:
+        {%- for permission in create_permissions %}
+          - {{ permission }}
+        {%- endfor -%}
+        {%- endif %}
+        """
         model = request.desired_state
 
         # TODO: validations
@@ -50,16 +88,61 @@ class {{ resource }}Provider({{ resource }}ProviderBase):
         self,
         request: ResourceRequest[{{ resource }}Properties],
     ) -> ProgressEvent[{{ resource }}Properties]:
+        """
+        Fetch resource information
+
+        {% if read_permissions -%}
+        IAM permissions required:
+        {%- for permission in read_permissions %}
+          - {{ permission }}
+        {%- endfor %}
+        {%- endif %}
+        """
         raise NotImplementedError
 
     def delete(
         self,
         request: ResourceRequest[{{ resource }}Properties],
     ) -> ProgressEvent[{{ resource }}Properties]:
+        """
+        Delete a resource
+
+        {% if delete_permissions -%}
+        IAM permissions required:
+        {%- for permission in delete_permissions %}
+          - {{ permission }}
+        {%- endfor %}
+        {%- endif %}
+        """
         raise NotImplementedError
 
     def update(
         self,
         request: ResourceRequest[{{ resource }}Properties],
     ) -> ProgressEvent[{{ resource }}Properties]:
+        """
+        Update a resource
+
+        {% if update_permissions -%}
+        IAM permissions required:
+        {%- for permission in update_permissions %}
+          - {{ permission }}
+        {%- endfor %}
+        {%- endif %}
+        """
+        raise NotImplementedError
+
+    def list(
+        self,
+        request: ResourceRequest[{{ resource }}Properties],
+    ) -> ProgressEvent[{{ resource }}Properties]:
+        """
+        List available resources of this type
+        {% if list_permissions -%}
+        IAM permissions required:
+        {%- for permission in list_permissions %}
+          - {{ permission }}
+        {%- endfor %}
+        {%- endif %}
+        """
         raise NotImplementedError
diff --git a/localstack-core/localstack/services/sqs/resource_providers/aws_sqs_queuepolicy.py b/localstack-core/localstack/services/sqs/resource_providers/aws_sqs_queuepolicy.py
@@ -86,3 +86,12 @@ def update(
             status=OperationStatus.SUCCESS,
             resource_model=model,
         )
+
+    def list(
+        self,
+        request: ResourceRequest[SQSQueuePolicyProperties],
+    ) -> ProgressEvent[SQSQueuePolicyProperties]:
+        """
+        List available resources of this type
+        """
+        raise NotImplementedError
diff --git a/localstack-core/localstack/services/sqs/resource_providers/generated/aws_sqs_queuepolicy_base.py b/localstack-core/localstack/services/sqs/resource_providers/generated/aws_sqs_queuepolicy_base.py
@@ -93,3 +93,14 @@ def update(
           - sqs:SetQueueAttributes
         """
         raise NotImplementedError
+
+    @abstractmethod
+    def list(
+        self,
+        request: ResourceRequest[SQSQueuePolicyProperties],
+    ) -> ProgressEvent[SQSQueuePolicyProperties]:
+        """
+        List available resources of this type
+
+        """
+        raise NotImplementedError
