changes for code review

And reformatted with Black

Author: meyertst-aws

python/example_code/scheduler/README.md

@@ -44,9 +44,9 @@ python -m pip install -r requirements.txt
 Code excerpts that show you how to call individual service functions.
 
 - [CreateSchedule](scheduler_wrapper.py#L38)
-- [CreateScheduleGroup](scheduler_wrapper.py#L127)
-- [DeleteSchedule](scheduler_wrapper.py#L102)
-- [DeleteScheduleGroup](scheduler_wrapper.py#L153)
+- [CreateScheduleGroup](scheduler_wrapper.py#L131)
+- [DeleteSchedule](scheduler_wrapper.py#L104)
+- [DeleteScheduleGroup](scheduler_wrapper.py#L160)
 
 ### Scenarios
 

python/example_code/scheduler/hello/hello_scheduler.py

@@ -16,18 +16,19 @@ def hello_scheduler(scheduler_client):
                              the low-level Amazon EventBridge Scheduler service API.
     """
     print("Hello, Amazon EventBridge Scheduler! Let's list some of your schedules:\n")
-    paginator = scheduler_client.get_paginator('list_schedules')
-    page_iterator = paginator.paginate(PaginationConfig={'MaxItems':10})
+    paginator = scheduler_client.get_paginator("list_schedules")
+    page_iterator = paginator.paginate(PaginationConfig={"MaxItems": 10})
 
     schedule_names: [str] = []
     for page in page_iterator:
-        for schedule in page['Schedules']:
-            schedule_names.append(schedule['Name'])
+        for schedule in page["Schedules"]:
+            schedule_names.append(schedule["Name"])
 
     print(f"{len(schedule_names)} schedule(s) retrieved.")
     for schedule_name in schedule_names:
         print(f"\t{schedule_name}")
 
+
 if __name__ == "__main__":
     hello_scheduler(boto3.client("scheduler"))
-# snippet-end:[python.example_code.scheduler.Hello]
+# snippet-end:[python.example_code.scheduler.Hello]

python/example_code/scheduler/scenario/resources/scheduler-workflow.png

@@ -26,8 +26,6 @@
 import demo_tools.question as q
 
 
-
-
 DASHES = "-" * 80
 
 sys.path
@@ -76,7 +74,10 @@ def run(self) -> None:
         print(DASHES)
 
         print(DASHES)
-        if q.ask("Do you want to delete all resources created by this workflow? (y/n) ", q.is_yesno):
+        if q.ask(
+            "Do you want to delete all resources created by this workflow? (y/n) ",
+            q.is_yesno,
+        ):
             self.cleanup()
         print(DASHES)
 
@@ -122,8 +123,12 @@ def prepare_application(self) -> None:
         print(f"Stack output RoleARN: {self.role_arn}")
         print(f"Stack output SNStopicARN: a")
         schedule_group_name = "workflow-schedules-group"
-        schedule_group_arn = self.eventbridge_scheduler.create_schedule_group(schedule_group_name)
-        print(f"Successfully created schedule group '{self.schedule_group_name}': {schedule_group_arn}.")
+        schedule_group_arn = self.eventbridge_scheduler.create_schedule_group(
+            schedule_group_name
+        )
+        print(
+            f"Successfully created schedule group '{self.schedule_group_name}': {schedule_group_arn}."
+        )
         self.schedule_group_name = schedule_group_name
         print("Application preparation complete.")
 
@@ -151,20 +156,23 @@ def create_one_time_schedule(self) -> None:
             delete_after_completion=True,
             use_flexible_time_window=True,
         )
-        print(f"Successfully created schedule '{schedule_name}' in schedule group 'workflow-schedules-group': {schedule_arn}.")
+        print(
+            f"Successfully created schedule '{schedule_name}' in schedule group 'workflow-schedules-group': {schedule_arn}."
+        )
         print(f"Subscription email will receive an email from this event.")
         print(f"You must confirm your subscription to receive event emails.")
         print(f"One-time schedule '{schedule_name}' created successfully.")
 
-
     def create_recurring_schedule(self) -> None:
         """
         Create a recurring schedule to send events at a specified rate in minutes.
         """
 
-        print("Creating a recurring schedule to send events for one hour...");
-        schedule_name = q.ask("Enter a name for the recurring schedule: ");
-        schedule_rate_in_minutes = q.ask("Enter the desired schedule rate (in minutes): ", q.is_int);
+        print("Creating a recurring schedule to send events for one hour...")
+        schedule_name = q.ask("Enter a name for the recurring schedule: ")
+        schedule_rate_in_minutes = q.ask(
+            "Enter the desired schedule rate (in minutes): ", q.is_int
+        )
 
         schedule_arn = self.eventbridge_scheduler.create_schedule(
             schedule_name,
@@ -175,12 +183,18 @@ def create_recurring_schedule(self) -> None:
             f"Recurrent event test from schedule {schedule_name}.",
         )
 
-        print(f"Successfully created schedule '{schedule_name}' in schedule group 'workflow-schedules-group': {schedule_arn}.")
-        print(f"Subscription email will receive an email from this event.");
-        print(f"You must confirm your subscription to receive event emails.");
+        print(
+            f"Successfully created schedule '{schedule_name}' in schedule group 'workflow-schedules-group': {schedule_arn}."
+        )
+        print(f"Subscription email will receive an email from this event.")
+        print(f"You must confirm your subscription to receive event emails.")
 
-        if q.ask(f"Are you ready to delete the '{schedule_name}' schedule? (y/n)", q.is_yesno) :
-            self.eventbridge_scheduler.delete_schedule(schedule_name, self.schedule_group_name)
+        if q.ask(
+            f"Are you ready to delete the '{schedule_name}' schedule? (y/n)", q.is_yesno
+        ):
+            self.eventbridge_scheduler.delete_schedule(
+                schedule_name, self.schedule_group_name
+            )
 
     def deploy_cloudformation_stack(
         self, stack_name: str, cfn_template: str, parameters: [dict[str, str]]
@@ -220,7 +234,9 @@ def destroy_cloudformation_stack(self, stack: ServiceResource) -> None:
 
         :param stack: The CloudFormation stack that manages the example resources.
         """
-        print(f"CloudFormation stack '{stack.name}' is being deleted. This may take a few minutes.")
+        print(
+            f"CloudFormation stack '{stack.name}' is being deleted. This may take a few minutes."
+        )
         stack.delete()
         waiter = self.cloud_formation_resource.meta.client.get_waiter(
             "stack_delete_complete"
@@ -269,4 +285,4 @@ def get_template_as_string() -> str:
         if demo is not None:
             demo.cleanup()
 
-# snippet-end:[python.example_code.scheduler.FeatureScenario]
+# snippet-end:[python.example_code.scheduler.FeatureScenario]

python/example_code/scheduler/scenario/scheduler_scenario.py

@@ -27,14 +27,20 @@
 
 
 class ScenarioData:
-    def __init__(self, scheduler_client, cloud_formation_resource, scheduler_stubber, cloud_formation_stubber):
+    def __init__(
+        self,
+        scheduler_client,
+        cloud_formation_resource,
+        scheduler_stubber,
+        cloud_formation_stubber,
+    ):
         self.scheduler_client = scheduler_client
-        self.cloud_formation_resource= cloud_formation_resource
+        self.cloud_formation_resource = cloud_formation_resource
         self.scheduler_stubber = scheduler_stubber
         self.cloud_formation_stubber = cloud_formation_stubber
         self.scenario = scheduler_scenario.SchedulerScenario(
             scheduler_wrapper=SchedulerWrapper(self.scheduler_client),
-        cloud_formation_resource=self.cloud_formation_resource,
+            cloud_formation_resource=self.cloud_formation_resource,
         )
 
 
@@ -44,8 +50,14 @@ def scenario_data(make_stubber):
     scheduler_stubber = make_stubber(scheduler_client)
     cloud_formation_resource = boto3.resource("cloudformation")
     cloud_formation_stubber = make_stubber(cloud_formation_resource.meta.client)
-    return ScenarioData(scheduler_client, cloud_formation_resource, scheduler_stubber, cloud_formation_stubber)
+    return ScenarioData(
+        scheduler_client,
+        cloud_formation_resource,
+        scheduler_stubber,
+        cloud_formation_stubber,
+    )
+
 
 @pytest.fixture
 def mock_wait(monkeypatch):
-    return
+    return

python/example_code/scheduler/scenario/test/conftest.py

@@ -26,9 +26,9 @@ def __init__(self, eventbridge_scheduler_client: client):
     @classmethod
     def from_client(cls) -> "SchedulerWrapper":
         """
-        Creates a SchedulerWrapper instance with a default EventBridge client.
+        Creates a SchedulerWrapper instance with a default EventBridge Scheduler client.
 
-        :return: An instance of SchedulerWrapper initialized with the default EventBridge client.
+        :return: An instance of SchedulerWrapper initialized with the default EventBridge Scheduler client.
         """
         eventbridge_scheduler_client = boto3.client("scheduler")
         return cls(eventbridge_scheduler_client)
@@ -94,7 +94,9 @@ def create_schedule(
                     err.response["Error"]["Message"],
                 )
             else:
-                logger.error("Error creating schedule: %s", err.response["Error"]["Message"])
+                logger.error(
+                    "Error creating schedule: %s", err.response["Error"]["Message"]
+                )
             raise
 
     # snippet-end:[python.example_code.scheduler.CreateSchedule]
@@ -119,7 +121,9 @@ def delete_schedule(self, name: str, schedule_group_name: str) -> None:
                     err.response["Error"]["Message"],
                 )
             else:
-                logger.error("Error deleting schedule: %s", err.response["Error"]["Message"])
+                logger.error(
+                    "Error deleting schedule: %s", err.response["Error"]["Message"]
+                )
                 raise
 
     # snippet-end:[python.example_code.scheduler.DeleteSchedule]
@@ -145,7 +149,10 @@ def create_schedule_group(self, name: str) -> str:
                     err.response["Error"]["Message"],
                 )
             else:
-                logger.error("Error creating schedule group: %s", err.response["Error"]["Message"])
+                logger.error(
+                    "Error creating schedule group: %s",
+                    err.response["Error"]["Message"],
+                )
             raise
 
     # snippet-end:[python.example_code.scheduler.CreateScheduleGroup]
@@ -168,7 +175,10 @@ def delete_schedule_group(self, name: str) -> None:
                     err.response["Error"]["Message"],
                 )
             else:
-                logger.error("Error deleting schedule group: %s", err.response["Error"]["Message"])
+                logger.error(
+                    "Error deleting schedule group: %s",
+                    err.response["Error"]["Message"],
+                )
                 raise
         # snippet-end:[python.example_code.scheduler.DeleteScheduleGroup]