Skip to content

Document root workflow namespace omission #1808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yuandrew wants to merge 1 commit into from
Closed

Document root workflow namespace omission #1808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions temporalio/client/_workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1255,10 +1255,18 @@ class WorkflowExecution:
"""Run ID for the parent workflow if this was started as a child."""

root_id: str | None
"""ID for the root workflow."""
"""ID for the root workflow.

The root namespace is not retained and may differ from this workflow's namespace for
cross-namespace child workflows. Track it separately if needed.
"""

root_run_id: str | None
"""Run ID for the root workflow."""
"""Run ID for the root workflow.

The root namespace is not retained and may differ from this workflow's namespace for
cross-namespace child workflows. Track it separately if needed.
"""

raw_info: temporalio.api.workflow.v1.WorkflowExecutionInfo
"""Underlying protobuf info."""
Expand Down
8 changes: 7 additions & 1 deletion temporalio/workflow/_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ class Info:
namespace: str
parent: ParentInfo | None
root: RootInfo | None
"""Root information. Its namespace is not retained and may differ from this workflow's
namespace for cross-namespace child workflows. Track it separately if needed."""
priority: temporalio.common.Priority
"""The priority of this workflow execution. If not set, or this server predates priorities,
then returns a default instance."""
Expand Down Expand Up @@ -217,7 +219,11 @@ class ParentInfo:

@dataclass(frozen=True)
class RootInfo:
"""Information about the root workflow."""
"""Information about the root workflow.

The namespace is not retained and may differ from the current workflow's namespace for
cross-namespace child workflows. Track it separately if needed.
"""

run_id: str
workflow_id: str
Expand Down
Loading