Add flake8 and pytest configuration

Author: cgillum

durabletask/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 """Durable Task SDK for Python"""
 
-PACKAGE_NAME="durabletask"
+PACKAGE_NAME = "durabletask"

durabletask/api/state.py

@@ -1,9 +1,11 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 from dataclasses import dataclass
 from datetime import datetime
 
-import durabletask.protos.orchestrator_service_pb2 as pb
 import durabletask.protos.helpers as helpers
-from durabletask.protos.orchestrator_service_pb2 import TaskFailureDetails
+import durabletask.protos.orchestrator_service_pb2 as pb
 
 
 @dataclass

durabletask/api/task_hub_client.py

@@ -1,19 +1,22 @@
-from dataclasses import dataclass
-from datetime import datetime
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 import logging
-from typing import Any, TypeVar
 import uuid
+from datetime import datetime
+from typing import TypeVar
+
 import grpc
-from durabletask.api.state import OrchestrationState, new_orchestration_state
-import durabletask.protos.helpers as helpers
-import durabletask.protos.orchestrator_service_pb2 as pb
-import durabletask.internal.shared as shared
 import simplejson as json
-
 from google.protobuf import wrappers_pb2
 
+import durabletask.internal.shared as shared
+import durabletask.protos.helpers as helpers
+import durabletask.protos.orchestrator_service_pb2 as pb
 import durabletask.task.registry as registry
-from durabletask.protos.orchestrator_service_pb2_grpc import TaskHubSidecarServiceStub
+from durabletask.api.state import OrchestrationState, new_orchestration_state
+from durabletask.protos.orchestrator_service_pb2_grpc import \
+    TaskHubSidecarServiceStub
 from durabletask.task.orchestration import Orchestrator
 
 TInput = TypeVar('TInput')

durabletask/internal/shared.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 import logging
 
 import grpc
@@ -14,7 +17,9 @@ def get_grpc_channel(host_address: str | None) -> grpc.Channel:
     return channel
 
 
-def get_logger(log_handler: logging.Handler | None = None, log_formatter: logging.Formatter | None = None) -> logging.Logger:
+def get_logger(
+        log_handler: logging.Handler | None = None,
+        log_formatter: logging.Formatter | None = None) -> logging.Logger:
     logger = logging.Logger("durabletask")
 
     # Add a default log handler if none is provided

durabletask/protos/helpers.py

@@ -1,107 +1,116 @@
-import simplejson as json
-import traceback
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
+import traceback
 from datetime import datetime
 from typing import Any
+
+import simplejson as json
 from google.protobuf import timestamp_pb2, wrappers_pb2
 
-from durabletask.protos.orchestrator_service_pb2 import *
+import durabletask.protos.orchestrator_service_pb2 as pb
 
 # TODO: The new_xxx_event methods are only used by test code and should be moved elsewhere
 
 
-def new_orchestrator_started_event(timestamp: datetime | None = None) -> HistoryEvent:
+def new_orchestrator_started_event(timestamp: datetime | None = None) -> pb.HistoryEvent:
     ts = timestamp_pb2.Timestamp()
     if timestamp is not None:
         ts.FromDatetime(timestamp)
-    return HistoryEvent(eventId=-1, timestamp=ts, orchestratorStarted=OrchestratorStartedEvent())
+    return pb.HistoryEvent(eventId=-1, timestamp=ts, orchestratorStarted=pb.OrchestratorStartedEvent())
 
 
-def new_execution_started_event(name: str, instance_id: str, encoded_input: str | None = None) -> HistoryEvent:
-    return HistoryEvent(
+def new_execution_started_event(name: str, instance_id: str, encoded_input: str | None = None) -> pb.HistoryEvent:
+    return pb.HistoryEvent(
         eventId=-1,
         timestamp=timestamp_pb2.Timestamp(),
-        executionStarted=ExecutionStartedEvent(
-            name=name, input=get_string_value(encoded_input), orchestrationInstance=OrchestrationInstance(instanceId=instance_id)))
+        executionStarted=pb.ExecutionStartedEvent(
+            name=name,
+            input=get_string_value(encoded_input),
+            orchestrationInstance=pb.OrchestrationInstance(instanceId=instance_id)))
 
 
-def new_timer_created_event(timer_id: int, fire_at: datetime) -> HistoryEvent:
+def new_timer_created_event(timer_id: int, fire_at: datetime) -> pb.HistoryEvent:
     ts = timestamp_pb2.Timestamp()
     ts.FromDatetime(fire_at)
-    return HistoryEvent(
+    return pb.HistoryEvent(
         eventId=timer_id,
         timestamp=timestamp_pb2.Timestamp(),
-        timerCreated=TimerCreatedEvent(fireAt=ts)
+        timerCreated=pb.TimerCreatedEvent(fireAt=ts)
     )
 
 
-def new_timer_fired_event(timer_id: int, fire_at: datetime) -> HistoryEvent:
+def new_timer_fired_event(timer_id: int, fire_at: datetime) -> pb.HistoryEvent:
     ts = timestamp_pb2.Timestamp()
     ts.FromDatetime(fire_at)
-    return HistoryEvent(
+    return pb.HistoryEvent(
         eventId=-1,
         timestamp=timestamp_pb2.Timestamp(),
-        timerFired=TimerFiredEvent(fireAt=ts, timerId=timer_id)
+        timerFired=pb.TimerFiredEvent(fireAt=ts, timerId=timer_id)
     )
 
 
-def new_task_scheduled_event(event_id: int, name: str, encoded_input: str | None = None) -> HistoryEvent:
-    return HistoryEvent(
+def new_task_scheduled_event(event_id: int, name: str, encoded_input: str | None = None) -> pb.HistoryEvent:
+    return pb.HistoryEvent(
         eventId=event_id,
         timestamp=timestamp_pb2.Timestamp(),
-        taskScheduled=TaskScheduledEvent(name=name, input=get_string_value(encoded_input))
+        taskScheduled=pb.TaskScheduledEvent(name=name, input=get_string_value(encoded_input))
     )
 
 
-def new_task_completed_event(event_id: int, encoded_output: str | None = None) -> HistoryEvent:
-    return HistoryEvent(
+def new_task_completed_event(event_id: int, encoded_output: str | None = None) -> pb.HistoryEvent:
+    return pb.HistoryEvent(
         eventId=-1,
         timestamp=timestamp_pb2.Timestamp(),
-        taskCompleted=TaskCompletedEvent(taskScheduledId=event_id, result=get_string_value(encoded_output))
+        taskCompleted=pb.TaskCompletedEvent(taskScheduledId=event_id, result=get_string_value(encoded_output))
     )
 
 
-def new_task_failed_event(event_id: int, ex: Exception) -> HistoryEvent:
-    return HistoryEvent(
+def new_task_failed_event(event_id: int, ex: Exception) -> pb.HistoryEvent:
+    return pb.HistoryEvent(
         eventId=-1,
         timestamp=timestamp_pb2.Timestamp(),
-        taskFailed=TaskFailedEvent(taskScheduledId=event_id, failureDetails=new_failure_details(ex))
+        taskFailed=pb.TaskFailedEvent(taskScheduledId=event_id, failureDetails=new_failure_details(ex))
     )
 
 
-def new_sub_orchestration_created_event(event_id: int, name: str, instance_id: str, encoded_input: str | None = None) -> HistoryEvent:
-    return HistoryEvent(
+def new_sub_orchestration_created_event(
+        event_id: int,
+        name: str,
+        instance_id: str,
+        encoded_input: str | None = None) -> pb.HistoryEvent:
+    return pb.HistoryEvent(
         eventId=event_id,
         timestamp=timestamp_pb2.Timestamp(),
-        subOrchestrationInstanceCreated=SubOrchestrationInstanceCreatedEvent(
+        subOrchestrationInstanceCreated=pb.SubOrchestrationInstanceCreatedEvent(
             name=name,
             input=get_string_value(encoded_input),
             instanceId=instance_id)
     )
 
 
-def new_sub_orchestration_completed_event(event_id: int, encoded_output: str | None = None) -> HistoryEvent:
-    return HistoryEvent(
+def new_sub_orchestration_completed_event(event_id: int, encoded_output: str | None = None) -> pb.HistoryEvent:
+    return pb.HistoryEvent(
         eventId=-1,
         timestamp=timestamp_pb2.Timestamp(),
-        subOrchestrationInstanceCompleted=SubOrchestrationInstanceCompletedEvent(
+        subOrchestrationInstanceCompleted=pb.SubOrchestrationInstanceCompletedEvent(
             result=get_string_value(encoded_output),
             taskScheduledId=event_id)
     )
 
 
-def new_sub_orchestration_failed_event(event_id: int, ex: Exception) -> HistoryEvent:
-    return HistoryEvent(
+def new_sub_orchestration_failed_event(event_id: int, ex: Exception) -> pb.HistoryEvent:
+    return pb.HistoryEvent(
         eventId=-1,
         timestamp=timestamp_pb2.Timestamp(),
-        subOrchestrationInstanceFailed=SubOrchestrationInstanceFailedEvent(
+        subOrchestrationInstanceFailed=pb.SubOrchestrationInstanceFailedEvent(
             failureDetails=new_failure_details(ex),
             taskScheduledId=event_id)
     )
 
 
-def new_failure_details(ex: Exception) -> TaskFailureDetails:
-    return TaskFailureDetails(
+def new_failure_details(ex: Exception) -> pb.TaskFailureDetails:
+    return pb.TaskFailureDetails(
         errorType=type(ex).__name__,
         errorMessage=str(ex),
         stackTrace=wrappers_pb2.StringValue(value=''.join(traceback.format_tb(ex.__traceback__)))
@@ -117,29 +126,29 @@ def get_string_value(val: str | None) -> wrappers_pb2.StringValue | None:
 
 def new_complete_orchestration_action(
         id: int,
-        status: OrchestrationStatus,
+        status: pb.OrchestrationStatus,
         result: str | None = None,
-        failure_details: TaskFailureDetails | None = None) -> OrchestratorAction:
+        failure_details: pb.TaskFailureDetails | None = None) -> pb.OrchestratorAction:
 
-    completeOrchestrationAction = CompleteOrchestrationAction(
+    completeOrchestrationAction = pb.CompleteOrchestrationAction(
         orchestrationStatus=status,
         result=get_string_value(result),
         failureDetails=failure_details)
 
     # TODO: CarryoverEvents
 
-    return OrchestratorAction(id=id, completeOrchestration=completeOrchestrationAction)
+    return pb.OrchestratorAction(id=id, completeOrchestration=completeOrchestrationAction)
 
 
-def new_create_timer_action(id: int, fire_at: datetime) -> OrchestratorAction:
+def new_create_timer_action(id: int, fire_at: datetime) -> pb.OrchestratorAction:
     timestamp = timestamp_pb2.Timestamp()
     timestamp.FromDatetime(fire_at)
-    return OrchestratorAction(id=id, createTimer=CreateTimerAction(fireAt=timestamp))
+    return pb.OrchestratorAction(id=id, createTimer=pb.CreateTimerAction(fireAt=timestamp))
 
 
-def new_schedule_task_action(id: int, name: str, input: Any) -> OrchestratorAction:
+def new_schedule_task_action(id: int, name: str, input: Any) -> pb.OrchestratorAction:
     encoded_input = json.dumps(input) if input is not None else None
-    return OrchestratorAction(id=id, scheduleTask=ScheduleTaskAction(
+    return pb.OrchestratorAction(id=id, scheduleTask=pb.ScheduleTaskAction(
         name=name,
         input=get_string_value(encoded_input)
     ))
@@ -151,9 +160,13 @@ def new_timestamp(dt: datetime) -> timestamp_pb2.Timestamp:
     return ts
 
 
-def new_create_sub_orchestration_action(id: int, name: str, instance_id: str | None, input: Any) -> OrchestratorAction:
+def new_create_sub_orchestration_action(
+        id: int,
+        name: str,
+        instance_id: str | None,
+        input: Any) -> pb.OrchestratorAction:
     encoded_input = json.dumps(input) if input is not None else None
-    return OrchestratorAction(id=id, createSubOrchestration=CreateSubOrchestrationAction(
+    return pb.OrchestratorAction(id=id, createSubOrchestration=pb.CreateSubOrchestrationAction(
         name=name,
         instanceId=instance_id,
         input=get_string_value(encoded_input)

durabletask/task/activities.py

@@ -1,7 +1,8 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
 from typing import Callable, TypeVar
 
-
 TInput = TypeVar('TInput')
 TOutput = TypeVar('TOutput')
 

durabletask/task/execution.py

@@ -1,7 +1,10 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 from datetime import datetime
 from logging import Logger
 from types import GeneratorType
-from typing import Any, Dict, Generator, Iterable, List, TypeVar
+from typing import Any, Generator, Iterable, List, TypeVar
 
 import simplejson as json
 
@@ -79,7 +82,7 @@ def set_complete(self, result: Any):
         self._is_complete = True
         self._result = result
         result_json: str | None = None
-        if result != None:
+        if result is not None:
             result_json = json.dumps(result)
         action = ph.new_complete_orchestration_action(
             self.next_sequence_number(), pb.ORCHESTRATION_STATUS_COMPLETED, result_json)

durabletask/task/orchestration.py

@@ -1,12 +1,15 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 # See https://peps.python.org/pep-0563/
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
 from datetime import datetime
 from typing import Any, Callable, Generator, TypeVar
-from durabletask.task.activities import Activity
 
 import durabletask.task.task as task
+from durabletask.task.activities import Activity
 
 TInput = TypeVar('TInput')
 TOutput = TypeVar('TOutput')
@@ -103,7 +106,7 @@ def call_activity(self, activity: Activity[TInput, TOutput], *,
         pass
 
     @abstractmethod
-    def call_sub_orchestrator(self,  orchestrator: Orchestrator[TInput, TOutput], *,
+    def call_sub_orchestrator(self, orchestrator: Orchestrator[TInput, TOutput], *,
                               input: TInput | None = None,
                               instance_id: str | None = None) -> task.Task[TOutput]:
         """Schedule sub-orchestrator function for execution.

durabletask/task/registry.py

@@ -1,6 +1,9 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 from typing import Callable, Dict
-from durabletask.task.activities import Activity
 
+from durabletask.task.activities import Activity
 from durabletask.task.orchestration import Orchestrator
 
 

durabletask/task/task.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 # See https://peps.python.org/pep-0563/
 from __future__ import annotations