Add generated protos (#42)

Author: cretz

.github/workflows/ci.yml

@@ -18,6 +18,7 @@ jobs:
           - os: ubuntu-latest
             python: 3.10
             docsTarget: true
+            protoCheckTarget: true
     runs-on: ${{ matrix.os }}
     steps:
       - name: Print build information
@@ -41,6 +42,14 @@ jobs:
       - run: poe build-develop
       - run: poe test -s -o log_cli_level=DEBUG
 
+      # Confirm protos are already generated properly
+      - name: Check generated protos
+        if: ${{ matrix.protoCheckTarget }}
+        run: |
+          poe gen-protos
+          poe format
+          [[ -z $(git status --porcelain) ]] || (git status; echo "Protos changed"; exit 1)
+
       # Do docs stuff (only on one host)
       - name: Build API docs
         if: ${{ matrix.docsTarget }}
@@ -91,7 +100,6 @@ jobs:
           go-version: "1.17"
       - run: python -m pip install --upgrade wheel poetry poethepoet
       - run: poetry install --no-root
-      - run: poe gen-protos
       - run: poetry build
       - run: poe fix-wheel
       - run: poe test-dist-single

.gitignore

@@ -2,10 +2,6 @@
 __pycache__
 /build
 /dist
-temporalio/api/*
-!temporalio/api/__init__.py
-temporalio/bridge/proto/*
-!temporalio/bridge/proto/__init__.py
 temporalio/bridge/target/
 temporalio/bridge/temporal_sdk_bridge*
 /tests/helpers/golangserver/golangserver

README.md

@@ -595,12 +595,6 @@ it):
 poetry install --no-root
 ```
 
-Now generate the protobuf code:
-
-```bash
-poe gen-protos
-```
-
 #### Build
 
 Now perform the release build:
@@ -680,7 +674,6 @@ installing dependencies, and generating the protobuf code:
 git clone --recursive https://github.com/temporalio/sdk-python.git
 cd sdk-python
 poetry install --no-root
-poe gen-protos
 ```
 
 Now compile the Rust extension in develop mode which is quicker than release mode:

pyproject.toml

@@ -51,7 +51,7 @@ toml = "^0.10.2"
 twine = "^3.8.0"
 
 [tool.poe.tasks]
-build-develop = ["gen-protos", "build-bridge-develop"]
+build-develop = ["build-bridge-develop"]
 build-bridge-develop = "python scripts/setup_bridge.py develop"
 fix-wheel = "python scripts/fix_wheel.py"
 format = [{cmd = "black ."}, {cmd = "isort ."}]

scripts/gen_protos.py

@@ -68,13 +68,22 @@ def fix_generated_output(base_path: Path):
                 f.write(content)
     # Write init
     with (base_path / "__init__.py").open("w") as f:
+        # Add docstring to API's init
+        if str(base_path.as_posix()).endswith("/temporal/api"):
+            f.write('"""gRPC API."""\n')
         # Imports
         message_names = []
         for stem, messages in imports.items():
             for message in messages:
-                f.write(f"from .{stem} import {message}\n")
+                # MyPy protobuf does not document this experimental class, see
+                # https://github.com/nipunn1313/mypy-protobuf/issues/212#issuecomment-885300106
+                import_suffix = ""
+                if stem == "service_pb2_grpc" and message == "WorkflowService":
+                    import_suffix = " # type: ignore"
+                f.write(f"from .{stem} import {message}{import_suffix}\n")
                 message_names.append(message)
         # __all__
+        message_names = sorted(message_names)
         if message_names:
             f.write(
                 f'\n__all__ = [\n    "' + '",\n    "'.join(message_names) + '",\n]\n'

temporalio/api/command/__init__.py

@@ -0,0 +1,33 @@
+from .message_pb2 import (
+    CancelTimerCommandAttributes,
+    CancelWorkflowExecutionCommandAttributes,
+    Command,
+    CompleteWorkflowExecutionCommandAttributes,
+    ContinueAsNewWorkflowExecutionCommandAttributes,
+    FailWorkflowExecutionCommandAttributes,
+    RecordMarkerCommandAttributes,
+    RequestCancelActivityTaskCommandAttributes,
+    RequestCancelExternalWorkflowExecutionCommandAttributes,
+    ScheduleActivityTaskCommandAttributes,
+    SignalExternalWorkflowExecutionCommandAttributes,
+    StartChildWorkflowExecutionCommandAttributes,
+    StartTimerCommandAttributes,
+    UpsertWorkflowSearchAttributesCommandAttributes,
+)
+
+__all__ = [
+    "CancelTimerCommandAttributes",
+    "CancelWorkflowExecutionCommandAttributes",
+    "Command",
+    "CompleteWorkflowExecutionCommandAttributes",
+    "ContinueAsNewWorkflowExecutionCommandAttributes",
+    "FailWorkflowExecutionCommandAttributes",
+    "RecordMarkerCommandAttributes",
+    "RequestCancelActivityTaskCommandAttributes",
+    "RequestCancelExternalWorkflowExecutionCommandAttributes",
+    "ScheduleActivityTaskCommandAttributes",
+    "SignalExternalWorkflowExecutionCommandAttributes",
+    "StartChildWorkflowExecutionCommandAttributes",
+    "StartTimerCommandAttributes",
+    "UpsertWorkflowSearchAttributesCommandAttributes",
+]