PyFlowchart

English | 机翻中文

PyFlowchart is a Python package that lets you:

• Write flowcharts in Python.
• Translate Python source code into flowcharts.

PyFlowchart produces flowcharts in the flowchart.js DSL, a widely used textual representation of flowcharts. You can convert these flowcharts to images using flowchart.js.org, francoislaberge/diagrams, or some Markdown editors. You can also output the generated flowchart directly as an interactive HTML page.

Get PyFlowchart

$ pip install pyflowchart

Quick Start

Want to flowchart your Python code in example.py? Run this:

$ python -m pyflowchart example.py
# or, if pyflowchart is on your PATH:
$ pyflowchart example.py

⚠️ PyFlowchart requires Python 3.7+ and is CI-tested on Python 3.7 through 3.14. To check your Python version, run python --version.

If you have both Python 2 and Python 3 installed, you may need to use python3 instead of python. This is becoming less common as Python 2 is sunsetting.

PyFlowchart will print the generated flowchart.js DSL to stdout. You can paste the output into flowchart.js.org or open it in editors like Typora to render the diagram.

To output an HTML file containing the rendered flowchart:

$ python -m pyflowchart example.py -o example.html
$ open example.html  # or open it manually in your browser

To flowchart a specific function or method:

$ python -m pyflowchart example.py -f function_name
# or a method inside a class:
$ python -m pyflowchart example.py -f ClassName.method_name

For example: python -m pyflowchart example.py -f MyClass.add.

🎉 Now you are ready to flowchart your code!

To learn more about how to use PyFlowchart, keep reading this document.

Flowchart in Python

PyFlowchart lets you write flowcharts in Python, which can be automatically translated into the flowchart.js DSL.

The following flowchart.js node types are supported:

• StartNode
• OperationNode
• ConditionNode
• InputOutputNode
• SubroutineNode
• EndNode

To connect nodes, use the connect() method. For ConditionNodes, use connect_yes() or connect_no(). You can optionally pass a direction string as the second argument to any connect call.

Create a Flowchart with your start node and call its flowchart() method to get the flowchart.js DSL:

from pyflowchart import *

st = StartNode('a_pyflow_test')
op = OperationNode('do something')
cond = ConditionNode('Yes or No?')
io = InputOutputNode(InputOutputNode.OUTPUT, 'something...')
sub = SubroutineNode('A Subroutine')
e = EndNode('a_pyflow_test')

st.connect(op)
op.connect(cond)
cond.connect_yes(io)
cond.connect_no(sub)
sub.connect(op, "right")  # sub->op line starts from the right of sub
io.connect(e)

fc = Flowchart(st)
print(fc.flowchart())

Output:

st0=>start: start a_pyflow_test
op1=>operation: do something
cond2=>condition: Yes or No?
io3=>inputoutput: output: something...
e5=>end: end a_pyflow_test
sub4=>subroutine: A Subroutine

st0->op1
op1->cond2
cond2->
cond2->
cond2(yes)->io3
io3->e5
cond2(no)->sub4
sub4(right)->op1

You can visit http://flowchart.js.org and paste the generated DSL to render an SVG flow diagram:

You can also call pyflowchart.output_html to generate a standalone HTML page with the rendered flowchart:

output_html('output.html', 'a_pyflow_test', fc.flowchart())

Many Markdown editors, like Typora, also support this flowchart syntax. See the Typora documentation on flowcharts. If you prefer the command line, try francoislaberge/diagrams.

Set Params to Nodes

Use the Node.set_param(key, value) method to attach flowchart.js node specifiers to a node:

element(param1=value1,param2=value2)=>start: Start

There is also a shortcut for setting the align-next=no parameter on a ConditionNode:

cond = ConditionNode("a cond node")
cond.no_align_next()
# or set it at construction time:
cond = ConditionNode("a cond node", align_next=False)

This is typically paired with a custom connection direction:

cond.connect_yes(op, "right")

The generated flowchart DSL will look like:

cond(align-next=no)=>condition: Yes or No?
...
cond(yes,right)->op

Python to Flowchart

PyFlowchart can also translate your Python code into flowcharts.

For example, given simple.py:

def foo(a, b):
    if a:
        print("a")
    else:
        for i in range(3):
            print("b")
    return a + b

Run in the terminal:

$ python -m pyflowchart simple.py

# output flowchart code.

Or from Python:

>>> from pyflowchart import Flowchart
>>> with open('simple.py') as f:
...     code = f.read()
...
>>> fc = Flowchart.from_code(code)
>>> print(fc.flowchart())

# output flowchart code.

Advanced Usages

Flowchart.from_code is the core function for translating Python code into a flowchart:

Flowchart.from_code(code, field="", inner=True, simplify=True, conds_align=False)

• code: Python source code to convert.
• field: Dotted path to a specific function or method (e.g. "MyClass.my_method"). Defaults to "" (the entire file).
• inner: If True, parse the body of the field. If False, treat the field itself as a single node.
• simplify: If True, a one-line if/loop body is collapsed into a single node.
• conds_align: If True, consecutive if statements are aligned in the flowchart (horizontally or vertically, depending on the layout).

The CLI mirrors this interface:

python -m pyflowchart [-f FIELD] [-i] [--no-simplify] [--conds-align] [-o OUTPUT] code_file

• -f FIELD: Dotted path to the target field.
• -i: Parse the body of the field (inner=True).
• --no-simplify: Disable one-line-body simplification.
• --conds-align: Enable consecutive-if alignment.
• -o OUTPUT: Write the result to a file. Currently only .html / .htm are supported (handled by output_html).

field

The field is the dotted path to a function (or method) you want to flowchart.

# example.py
print("start")

def foo():
    foo = "foo"

class Bar():
    def buzz(self, f):
        def g(self):
            print("g")
            f(self)
        return g(self)

Bar().buzz(foo)
print("end")

For example.py above, available paths are:

• "" (the whole file)
• "foo"
• "Bar.buzz"
• "Bar.buzz.g"

To generate a flowchart of Bar.buzz.g:

# Python
from pyflowchart import Flowchart
with open('example.py') as f:
    code = f.read()
fc = Flowchart.from_code(code, field='Bar.buzz.g', inner=False)
print(fc.flowchart())

Or:

# CLI
python -m pyflowchart example.py -f Bar.buzz.g

Output result:

inner

The inner parameter controls how the parser interprets the target field. With inner=True, PyFlowchart parses the body of the field; with inner=False, it treats the entire field as a single node.

In the CLI, passing -i sets inner=True; omitting -i means inner=False.

🔧 For developers: inner=True parses field.body; inner=False parses [field].

simplify

When simplify=True (the default), a one-line if or loop body is folded into the condition node itself.

# example_simplify.py
a = 1
if a == 1:
    print(a)
while a < 4:
    a = a + 1

With simplify=True:

flowchart = Flowchart.from_code(example_simplify_py, field="", inner=True)
print(flowchart.flowchart())
# CLI: python -m pyflowchart example_simplify.py

With simplify=False:

flowchart = Flowchart.from_code(example_simplify_py, field="", inner=True, simplify=False)
print(flowchart.flowchart())
# CLI: python -m pyflowchart --no-simplify example_simplify.py

conds-align (Beta)

When conds_align=True, consecutive if statements are aligned in the flowchart (horizontally or vertically, depending on the layout), which often makes the resulting diagram easier to read.

# example-conds-align.py
if cond1:
    op1
if cond2:
    op2
if cond3:
    op3
op_end

Note: This feature is still in beta and may not work correctly in all cases.

match-case (Python 3.10+)

PyFlowchart supports Python's structural pattern matching (match/case, introduced in Python 3.10). Each case branch is rendered as a condition node in the flowchart.

# example_match.py
def classify(status):
    match status:
        case 200:
            return "OK"
        case 404:
            return "Not Found"
        case _:
            return "Other"

$ python -m pyflowchart example_match.py -f classify

try/except/else/finally (Beta)

⚠️ Beta feature: try/except support is still in beta and may not work correctly in all cases.

PyFlowchart translates try/except/else/finally blocks into a structured flowchart that shows all exception-handling paths.

# example_try.py
def fetch(url):
    try:
        data = requests.get(url)
    except Timeout:
        data = cached()
    except Exception as e:
        log(