1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
"""Pipe bytes, strings, or string iterators through Graphviz ``dot``."""
import typing
from .. import _tools
from . import dot_command
from . import execute
__all__ = ['pipe', 'pipe_string',
'pipe_lines', 'pipe_lines_string']
@_tools.deprecate_positional_args(supported_number=3)
def pipe(engine: str, format: str, data: bytes,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
quiet: bool = False) -> bytes:
"""Return ``data`` (``bytes``) piped through ``engine`` into ``format`` as ``bytes``.
Args:
engine: Layout engine for rendering (``'dot'``, ``'neato'``, ...).
format: Output format for rendering (``'pdf'``, ``'png'``, ...).
data: Binary (encoded) DOT source bytes to render.
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
quiet: Suppress ``stderr`` output from the layout subprocess.
Returns:
Binary (encoded) stdout of the layout command.
Raises:
ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
are unknown.
graphviz.RequiredArgumentError: If ``formatter`` is given
but ``renderer`` is None.
graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
is not found.
graphviz.CalledProcessError: If the returncode (exit status)
of the rendering ``dot`` subprocess is non-zero.
Example:
>>> doctest_mark_exe()
>>> import graphviz
>>> graphviz.pipe('dot', 'svg', b'graph { hello -- world }')[:14]
b'<?xml version='
Note:
The layout command is started from the current directory.
"""
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
kwargs = {'input': data}
proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
return proc.stdout
def pipe_string(engine: str, format: str, input_string: str, *,
encoding: str,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
quiet: bool = False) -> str:
"""Return ``input_string`` piped through ``engine`` into ``format`` as string.
Args:
engine: Layout engine for rendering (``'dot'``, ``'neato'``, ...).
format: Output format for rendering (``'pdf'``, ``'png'``, ...).
input_string: Binary (encoded) DOT source bytes to render.
encoding: Encoding to en/decode subprocess stdin and stdout (required).
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
quiet: Suppress ``stderr`` output from the layout subprocess.
Returns:
Decoded stdout of the layout command.
Raises:
ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
are unknown.
graphviz.RequiredArgumentError: If ``formatter`` is given
but ``renderer`` is None.
graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
is not found.
graphviz.CalledProcessError: If the returncode (exit status)
of the rendering ``dot`` subprocess is non-zero.
Example:
>>> doctest_mark_exe()
>>> import graphviz
>>> graphviz.pipe_string('dot', 'svg', 'graph { spam }',
... encoding='ascii')[:14]
'<?xml version='
Note:
The layout command is started from the current directory.
"""
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
kwargs = {'input': input_string, 'encoding': encoding}
proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
return proc.stdout
def pipe_lines(engine: str, format: str, input_lines: typing.Iterator[str], *,
input_encoding: str,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
quiet: bool = False) -> bytes:
r"""Return ``input_lines`` piped through ``engine`` into ``format`` as ``bytes``.
Args:
engine: Layout engine for rendering (``'dot'``, ``'neato'``, ...).
format: Output format for rendering (``'pdf'``, ``'png'``, ...).
input_lines: DOT source lines to render (including final newline).
input_encoding: Encode input_lines for subprocess stdin (required).
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
quiet: Suppress ``stderr`` output from the layout subprocess.
Returns:
Binary stdout of the layout command.
Raises:
ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
are unknown.
graphviz.RequiredArgumentError: If ``formatter`` is given
but ``renderer`` is None.
graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
is not found.
graphviz.CalledProcessError: If the returncode (exit status)
of the rendering ``dot`` subprocess is non-zero.
Example:
>>> doctest_mark_exe()
>>> import graphviz
>>> graphviz.pipe_lines('dot', 'svg', iter(['graph { spam }\n']),
... input_encoding='ascii')[:14]
b'<?xml version='
Note:
The layout command is started from the current directory.
"""
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
kwargs = {'input_lines': (line.encode(input_encoding) for line in input_lines)}
proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
return proc.stdout
def pipe_lines_string(engine: str, format: str, input_lines: typing.Iterator[str], *,
encoding: str,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
quiet: bool = False) -> str:
r"""Return ``input_lines`` piped through ``engine`` into ``format`` as string.
Args:
engine: Layout engine for rendering (``'dot'``, ``'neato'``, ...).
format: Output format for rendering (``'pdf'``, ``'png'``, ...).
input_lines: DOT source lines to render (including final newline).
encoding: Encoding to en/decode subprocess stdin and stdout (required).
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
quiet: Suppress ``stderr`` output from the layout subprocess.
Returns:
Decoded stdout of the layout command.
Raises:
ValueError: If ``engine``, ``format``, ``renderer``, or ``formatter``
are unknown.
graphviz.RequiredArgumentError: If ``formatter`` is given
but ``renderer`` is None.
graphviz.ExecutableNotFound: If the Graphviz ``dot`` executable
is not found.
graphviz.CalledProcessError: If the returncode (exit status)
of the rendering ``dot`` subprocess is non-zero.
Example:
>>> doctest_mark_exe()
>>> import graphviz
>>> graphviz.pipe_lines_string('dot', 'svg', iter(['graph { spam }\n']),
... encoding='ascii')[:14]
'<?xml version='
Note:
The layout command is started from the current directory.
"""
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
kwargs = {'input_lines': input_lines, 'encoding': encoding}
proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
return proc.stdout
|
