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.9.1.tar.gz (43.9 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.9.1-py3-none-any.whl (51.6 kB view details)

Uploaded Python 3

File details

Details for the file pydantic_graph-2.9.1.tar.gz.

File metadata

  • Download URL: pydantic_graph-2.9.1.tar.gz
  • Upload date:
  • Size: 43.9 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.9.1.tar.gz
Algorithm Hash digest
SHA256 aa1690068812add07c3114cae28a765ee20438e44c7bf9c938d052e69155521c
MD5 11d397eb258ad76d320ee8fad284d5cb
BLAKE2b-256 eb79d769798ba7d2f789d557ea51ed79c66f9672ac198d6b6a763acb8d28c1b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_graph-2.9.1.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.9.1-py3-none-any.whl.

File metadata

  • Download URL: pydantic_graph-2.9.1-py3-none-any.whl
  • Upload date:
  • Size: 51.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pydantic_graph-2.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8b473d168e21f109014e5428def4e6aca151206fb9bd9725ec389b90f8ec61a2
MD5 7158e40caa27fdf7fe69507f0b8b48d6
BLAKE2b-256 48fecd0ee1a0b43c0f06134845f0d3d20bf92ca91c1441673d7ef1b413541bbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_graph-2.9.1-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