Minor doc update (#305)

Fixes #293
Fixes #285
Fixes #291

Author: cretz

README.md

@@ -92,6 +92,8 @@ event loop. This means task management, sleep, cancellation, etc have all been d
     - [Workflow Replay](#workflow-replay)
     - [OpenTelemetry Support](#opentelemetry-support)
     - [Protobuf 3.x vs 4.x](#protobuf-3x-vs-4x)
+    - [Known Compatibility Issues](#known-compatibility-issues)
+      - [gevent Patching](#gevent-patching)
 - [Development](#development)
     - [Building](#building)
       - [Prepare](#prepare)
@@ -1230,6 +1232,16 @@ versions can cause issues with the sandbox due to global state sharing. Temporal
 protobuf 4.x library unless you absolutely cannot at which point some proto libraries may have to be marked as
 [Passthrough Modules](#passthrough-modules).
 
+### Known Compatibility Issues
+
+Below are known compatibility issues with the Python SDK.
+
+#### gevent Patching
+
+When using `gevent.monkey.patch_all()`, asyncio event loops can get messed up, especially those using custom event loops
+like Temporal. See [this gevent issue](https://github.com/gevent/gevent/issues/982) and
+[this Python SDK issue](https://github.com/temporalio/sdk-python/issues/59) for more details.
+
 # Development
 
 The Python SDK is built to work with Python 3.7 and newer. It is built using

temporalio/worker/__init__.py

@@ -19,7 +19,12 @@
     WorkflowInterceptorClassInput,
     WorkflowOutboundInterceptor,
 )
-from ._replayer import Replayer, ReplayerConfig
+from ._replayer import (
+    Replayer,
+    ReplayerConfig,
+    WorkflowReplayResult,
+    WorkflowReplayResults,
+)
 from ._worker import Worker, WorkerConfig
 from ._workflow_instance import (
     UnsandboxedWorkflowRunner,
@@ -34,6 +39,8 @@
     "WorkerConfig",
     "Replayer",
     "ReplayerConfig",
+    "WorkflowReplayResult",
+    "WorkflowReplayResults",
     # Interceptor base classes
     "Interceptor",
     "ActivityInboundInterceptor",

temporalio/worker/_workflow_instance.py

@@ -800,14 +800,14 @@ def workflow_start_activity(
         self,
         activity: Any,
         *args: Any,
-        activity_id: Optional[str],
         task_queue: Optional[str],
         schedule_to_close_timeout: Optional[timedelta],
         schedule_to_start_timeout: Optional[timedelta],
         start_to_close_timeout: Optional[timedelta],
         heartbeat_timeout: Optional[timedelta],
         retry_policy: Optional[temporalio.common.RetryPolicy],
         cancellation_type: temporalio.workflow.ActivityCancellationType,
+        activity_id: Optional[str],
     ) -> temporalio.workflow.ActivityHandle[Any]:
         # Get activity definition if it's callable
         name: str
@@ -899,13 +899,13 @@ def workflow_start_local_activity(
         self,
         activity: Any,
         *args: Any,
-        activity_id: Optional[str],
         schedule_to_close_timeout: Optional[timedelta],
         schedule_to_start_timeout: Optional[timedelta],
         start_to_close_timeout: Optional[timedelta],
         retry_policy: Optional[temporalio.common.RetryPolicy],
         local_retry_threshold: Optional[timedelta],
         cancellation_type: temporalio.workflow.ActivityCancellationType,
+        activity_id: Optional[str],
     ) -> temporalio.workflow.ActivityHandle[Any]:
         # Get activity definition if it's callable
         name: str