Skip to main content

Graph and state machine library

Project description

Pydantic Graph

CI Coverage PyPI python versions license

Graph and finite state machine library.

This library is developed as part of Pydantic AI, however it has no dependency on pydantic-ai or related packages and can be considered as a pure graph-based state machine library. You may find it useful whether or not you're using Pydantic AI or even building with GenAI.

As with Pydantic AI, this library prioritizes type safety and use of common Python syntax over esoteric, domain-specific use of Python syntax.

pydantic-graph allows you to define graphs using standard Python syntax. In particular, edges are defined using the return type hint of nodes.

Full documentation is available at ai.pydantic.dev/graph.

Here's a basic example:

from __future__ import annotations

from dataclasses import dataclass

from pydantic_graph import BaseNode, End, GraphBuilder, GraphRunContext, StepContext


@dataclass
class DivisibleBy5(BaseNode[None, None, int]):
    foo: int

    async def run(
        self,
        ctx: GraphRunContext,
    ) -> Increment | End[int]:
        if self.foo % 5 == 0:
            return End(self.foo)
        else:
            return Increment(self.foo)


@dataclass
class Increment(BaseNode):
    foo: int

    async def run(self, ctx: GraphRunContext) -> DivisibleBy5:
        return DivisibleBy5(self.foo + 1)


g = GraphBuilder(input_type=int, output_type=int)


@g.step
async def start(ctx: StepContext[None, None, int]) -> DivisibleBy5:
    return DivisibleBy5(ctx.inputs)


g.add(
    g.node(DivisibleBy5),
    g.node(Increment),
    g.edge_from(g.start_node).to(start),
)

fives_graph = g.build()


async def main():
    result = await fives_graph.run(inputs=4)
    print(result)
    #> 5

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydantic_graph-2.0.0b1.tar.gz (43.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydantic_graph-2.0.0b1-py3-none-any.whl (50.8 kB view details)

Uploaded Python 3

File details

Details for the file pydantic_graph-2.0.0b1.tar.gz.

File metadata

  • Download URL: pydantic_graph-2.0.0b1.tar.gz
  • Upload date:
  • Size: 43.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pydantic_graph-2.0.0b1.tar.gz
Algorithm Hash digest
SHA256 4d152e785afbb00a9770c8f0c96e85dd27938d0c819d73f8f39ed53244e25de4
MD5 4b06bab8caa63472785aec70257195f6
BLAKE2b-256 a0f7c17fdddaccebea72f28f5ae451db57341b55dbdcaa92ec64cb2f14873e3e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_graph-2.0.0b1.tar.gz:

Publisher: ci.yml on pydantic/pydantic-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydantic_graph-2.0.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for pydantic_graph-2.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2ed53943afb723caee7271c6c3a721687552d52b661ef44393643f7ce0aa067
MD5 3d8528b29d3611ea2c31573e79b804bb
BLAKE2b-256 7014ebf32a40919b16b399f57d540ccf3e8eab9bfed80d245e0a67065014da57

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_graph-2.0.0b1-py3-none-any.whl:

Publisher: ci.yml on pydantic/pydantic-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page