harnest.extensions.hatchet

All Python modules · Import and compatibility guidance

Workflow operations

Operation	Result	Ownership
`run(name, input)`	`HatchetRun`	Submit and return immediately; the caller owns any later wait
`status(job)`	`HatchetRunStatus`	Read `QUEUED`, `RUNNING`, `COMPLETED`, `CANCELLED`, or `FAILED`
`wait(job)`	JSON mapping	Persist a continuation and resume when an existing run terminates
`run_and_wait(name, input)`	JSON mapping	Prove durable suspension support before submitting and waiting
`cancel(job)`	None	Request provider cancellation without claiming worker termination

Public contracts

API	Role
`hatchet` / `extension`	Installed `HatchetExtension` singleton
`HatchetRun`	Immutable provider run, workflow, and correlation identity
`HatchetRunStatus`	Stable provider-neutral terminal and non-terminal status enum
`HatchetContext`	Revocable invocation-scoped view used by the extension singleton

Exports

Name	Kind
`HatchetContext`	Class
`HatchetExtension`	Class
`HatchetRun`	Class
`HatchetRunStatus`	Class
`hatchet`	Namespace
`extension`	Namespace

HatchetContext

Typed invocation view exposed through context.extensions("hatchet").

HatchetContext(extension_name: str, owner: 'HatchetExtension') -> None

Parameters and example

Parameter	Type	Default
`extension_name`	`str`	Required
`owner`	`'HatchetExtension'`	Required

from harnest.extensions.hatchet import HatchetContext

context = HatchetContext(extension_name=..., owner=...)

HatchetContext.extension_name

Return the extension whose invocation authority this context carries.

Example

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
value = context.extension_name

HatchetContext.active

Report whether the owning managed invocation is still active.

Example

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
value = context.active

HatchetContext.continuations

Return provider-bound suspension authority for this invocation.

Example

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
value = context.continuations

HatchetContext.run

async HatchetContext.run(workflow_name: str, job_input: Mapping[str, Any]) -> HatchetRun

Submit external work without waiting in the agent request.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
run = await context.run(workflow_name=..., job_input=...)

HatchetContext.status

async HatchetContext.status(job: HatchetRun) -> HatchetRunStatus

Read one external job status through invocation credentials.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
status = await context.status(job=...)

HatchetContext.wait

async HatchetContext.wait(job: HatchetRun) -> Mapping[str, Any]

Suspend this tool continuation until Hatchet reaches a terminal state.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
result = await context.wait(job=...)

HatchetContext.run_and_wait

async HatchetContext.run_and_wait(workflow_name: str, job_input: Mapping[str, Any]) -> Mapping[str, Any]

Preflight durable suspension before submitting external work.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
result = await context.run_and_wait(workflow_name=..., job_input=...)

HatchetContext.cancel

async HatchetContext.cancel(job: HatchetRun) -> None

Request cancellation while leaving worker shutdown to its owner.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import HatchetContext

context: HatchetContext
await context.cancel(job=...)

HatchetExtension

Expose Hatchet as an invocation-safe native extension capability.

HatchetExtension() -> None

Example

from harnest.extensions.hatchet import HatchetExtension

extension = HatchetExtension()

HatchetExtension.start

async HatchetExtension.start(start_context: Any) -> None

Parameters and example

Parameter	Type	Default
`start_context`	`Any`	Required

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
await extension.start(start_context=...)

HatchetExtension.stop

async HatchetExtension.stop() -> None

Stop local pollers without cancelling independently durable Hatchet jobs.

Example

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
await extension.stop()

HatchetExtension.create_context

HatchetExtension.create_context(base: ExtensionContext) -> HatchetContext

Create a fresh revocable view after extension startup succeeds.

Parameters and example

Parameter	Type	Default
`base`	`ExtensionContext`	Required

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
context = extension.create_context(base=...)

HatchetExtension.context

Return the task-local extension context for the active invocation.

Example

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
value = extension.context

HatchetExtension.run

async HatchetExtension.run(workflow_name: str, job_input: Mapping[str, Any]) -> HatchetRun

Submit work through the context active in the current invocation.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
run = await extension.run(workflow_name=..., job_input=...)

HatchetExtension.status

async HatchetExtension.status(job: HatchetRun) -> HatchetRunStatus

Read job status through the active typed context.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
status = await extension.status(job=...)

HatchetExtension.wait

async HatchetExtension.wait(job: HatchetRun) -> Mapping[str, Any]

Suspend and resume the active authored tool continuation.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
result = await extension.wait(job=...)

HatchetExtension.run_and_wait

async HatchetExtension.run_and_wait(workflow_name: str, job_input: Mapping[str, Any]) -> Mapping[str, Any]

Submit only after the current invocation proves it can suspend.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
result = await extension.run_and_wait(workflow_name=..., job_input=...)

HatchetExtension.cancel

async HatchetExtension.cancel(job: HatchetRun) -> None

Cancel an external run through the active typed context.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import HatchetExtension

extension: HatchetExtension
await extension.cancel(job=...)

HatchetRun

Portable identity for work owned by the external Hatchet runtime.

HatchetRun(run_id: str, workflow_name: str, correlation_id: str) -> None

Fields (— means no declared default):

Field	Type	Default
`run_id`	`str`	`—`
`workflow_name`	`str`	`—`
`correlation_id`	`str`	`—`

Parameters and example

Parameter	Type	Default
`run_id`	`str`	Required
`workflow_name`	`str`	Required
`correlation_id`	`str`	Required

from harnest.extensions.hatchet import HatchetRun

run = HatchetRun(run_id=..., workflow_name=..., correlation_id=...)

HatchetRunStatus

Provider statuses that affect continuation decisions.

HatchetRunStatus(*values)

Member	Value
`QUEUED`	`'QUEUED'`
`RUNNING`	`'RUNNING'`
`COMPLETED`	`'COMPLETED'`
`CANCELLED`	`'CANCELLED'`
`FAILED`	`'FAILED'`

Example

from harnest.extensions.hatchet import HatchetRunStatus

value = HatchetRunStatus.QUEUED

hatchet

Expose Hatchet as an invocation-safe native extension capability.

Example

from harnest.extensions.hatchet import hatchet

hatchet.start

async hatchet.start(start_context: Any) -> None

Parameters and example

Parameter	Type	Default
`start_context`	`Any`	Required

from harnest.extensions.hatchet import hatchet

await hatchet.start(start_context=...)

hatchet.stop

async hatchet.stop() -> None

Stop local pollers without cancelling independently durable Hatchet jobs.

Example

from harnest.extensions.hatchet import hatchet

await hatchet.stop()

hatchet.create_context

hatchet.create_context(base: ExtensionContext) -> HatchetContext

Create a fresh revocable view after extension startup succeeds.

Parameters and example

Parameter	Type	Default
`base`	`ExtensionContext`	Required

from harnest.extensions.hatchet import hatchet

context = hatchet.create_context(base=...)

hatchet.context

Return the task-local extension context for the active invocation.

Example

from harnest.extensions.hatchet import hatchet

value = hatchet.context

hatchet.run

async hatchet.run(workflow_name: str, job_input: Mapping[str, Any]) -> HatchetRun

Submit work through the context active in the current invocation.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import hatchet

run = await hatchet.run(workflow_name=..., job_input=...)

hatchet.status

async hatchet.status(job: HatchetRun) -> HatchetRunStatus

Read job status through the active typed context.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import hatchet

status = await hatchet.status(job=...)

hatchet.wait

async hatchet.wait(job: HatchetRun) -> Mapping[str, Any]

Suspend and resume the active authored tool continuation.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import hatchet

result = await hatchet.wait(job=...)

hatchet.run_and_wait

async hatchet.run_and_wait(workflow_name: str, job_input: Mapping[str, Any]) -> Mapping[str, Any]

Submit only after the current invocation proves it can suspend.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import hatchet

result = await hatchet.run_and_wait(workflow_name=..., job_input=...)

hatchet.cancel

async hatchet.cancel(job: HatchetRun) -> None

Cancel an external run through the active typed context.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import hatchet

await hatchet.cancel(job=...)

extension

Expose Hatchet as an invocation-safe native extension capability.

Example

from harnest.extensions.hatchet import extension

extension.start

async extension.start(start_context: Any) -> None

Parameters and example

Parameter	Type	Default
`start_context`	`Any`	Required

from harnest.extensions.hatchet import extension

await extension.start(start_context=...)

extension.stop

async extension.stop() -> None

Stop local pollers without cancelling independently durable Hatchet jobs.

Example

from harnest.extensions.hatchet import extension

await extension.stop()

extension.create_context

extension.create_context(base: ExtensionContext) -> HatchetContext

Create a fresh revocable view after extension startup succeeds.

Parameters and example

Parameter	Type	Default
`base`	`ExtensionContext`	Required

from harnest.extensions.hatchet import extension

context = extension.create_context(base=...)

extension.context

Return the task-local extension context for the active invocation.

Example

from harnest.extensions.hatchet import extension

value = extension.context

extension.run

async extension.run(workflow_name: str, job_input: Mapping[str, Any]) -> HatchetRun

Submit work through the context active in the current invocation.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import extension

run = await extension.run(workflow_name=..., job_input=...)

extension.status

async extension.status(job: HatchetRun) -> HatchetRunStatus

Read job status through the active typed context.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import extension

status = await extension.status(job=...)

extension.wait

async extension.wait(job: HatchetRun) -> Mapping[str, Any]

Suspend and resume the active authored tool continuation.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import extension

result = await extension.wait(job=...)

extension.run_and_wait

async extension.run_and_wait(workflow_name: str, job_input: Mapping[str, Any]) -> Mapping[str, Any]

Submit only after the current invocation proves it can suspend.

Parameters and example

Parameter	Type	Default
`workflow_name`	`str`	Required
`job_input`	`Mapping[str, Any]`	Required

from harnest.extensions.hatchet import extension

result = await extension.run_and_wait(workflow_name=..., job_input=...)

extension.cancel

async extension.cancel(job: HatchetRun) -> None

Cancel an external run through the active typed context.

Parameters and example

Parameter	Type	Default
`job`	`HatchetRun`	Required

from harnest.extensions.hatchet import extension

await extension.cancel(job=...)

​Workflow operations

​Public contracts

​Exports

​HatchetContext

​HatchetContext.extension_name

​HatchetContext.active

​HatchetContext.continuations

​HatchetContext.run

​HatchetContext.status

​HatchetContext.wait

​HatchetContext.run_and_wait

​HatchetContext.cancel

​HatchetExtension

​HatchetExtension.start

​HatchetExtension.stop

​HatchetExtension.create_context

​HatchetExtension.context

​HatchetExtension.run

​HatchetExtension.status

​HatchetExtension.wait

​HatchetExtension.run_and_wait

​HatchetExtension.cancel

​HatchetRun

​HatchetRunStatus

​hatchet

​hatchet.start

​hatchet.stop

​hatchet.create_context

​hatchet.context

​hatchet.run

​hatchet.status

​hatchet.wait

​hatchet.run_and_wait

​hatchet.cancel

​extension

​extension.start

​extension.stop

​extension.create_context

​extension.context

​extension.run

​extension.status

​extension.wait

​extension.run_and_wait

​extension.cancel

Workflow operations

Public contracts

Exports

HatchetContext

HatchetContext.extension_name

HatchetContext.active

HatchetContext.continuations

HatchetContext.run

HatchetContext.status

HatchetContext.wait

HatchetContext.run_and_wait

HatchetContext.cancel

HatchetExtension

HatchetExtension.start

HatchetExtension.stop

HatchetExtension.create_context

HatchetExtension.context

HatchetExtension.run

HatchetExtension.status

HatchetExtension.wait

HatchetExtension.run_and_wait

HatchetExtension.cancel

HatchetRun

HatchetRunStatus

hatchet

hatchet.start

hatchet.stop

hatchet.create_context

hatchet.context

hatchet.run

hatchet.status

hatchet.wait

hatchet.run_and_wait

hatchet.cancel

extension

extension.start

extension.stop

extension.create_context

extension.context

extension.run

extension.status

extension.wait

extension.run_and_wait

extension.cancel