Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add axis invert support #174

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add axis invert support #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b47f23
Initial changes
AvisDX Apr 30, 2022
1d31c62
Fix tests and docs
AvisDX May 1, 2022
f4ffc39
Remove unnecessary formatted text
AvisDX May 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#graph-1
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False,
quiet_view: bool = False, *,
outfile: Union[os.PathLike, str, NoneType] = None,
Expand All @@ -496,6 +497,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#graph-1
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| invert_axis: Invert the axis via the -y flag
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
Expand Down Expand Up @@ -610,6 +612,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#graph-1
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False, *,
engine: Optional[str] = None,
encoding: Optional[str] = None) -> Union[bytes, str]
Expand All @@ -623,6 +626,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#graph-1
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| invert_axis: Invert the axis via the -y flag
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| engine: Layout engine for rendering
Expand Down Expand Up @@ -985,6 +989,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#digraph-1
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False,
quiet_view: bool = False, *,
outfile: Union[os.PathLike, str, NoneType] = None,
Expand All @@ -1008,6 +1013,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#digraph-1
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| invert_axis: Invert the axis via the -y flag
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
Expand Down Expand Up @@ -1122,6 +1128,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#digraph-1
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False, *,
engine: Optional[str] = None,
encoding: Optional[str] = None) -> Union[bytes, str]
Expand All @@ -1135,6 +1142,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#digraph-1
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| invert_axis: Invert the axis via the -y flag
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| engine: Layout engine for rendering
Expand Down Expand Up @@ -1394,6 +1402,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#source-1
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False,
quiet_view: bool = False, *,
outfile: Union[os.PathLike, str, NoneType] = None,
Expand All @@ -1417,6 +1426,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#source-1
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| invert_axis: Invert the axis via the -y flag
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| quiet_view (bool): Suppress ``stderr`` output
Expand Down Expand Up @@ -1514,6 +1524,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#source-1
renderer: Optional[str] = None,
formatter: Optional[str] = None,
neato_no_op: Union[bool, int, NoneType] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False, *,
engine: Optional[str] = None,
encoding: Optional[str] = None) -> Union[bytes, str]
Expand All @@ -1527,6 +1538,7 @@ https://github.com/xflr6/graphviz/blob/master/docs/api.rst#source-1
| formatter: The output formatter used for rendering
| (``'cairo'``, ``'gd'``, ...).
| neato_no_op: Neato layout engine no-op flag.
| invert_axis: Invert the axis via the -y flag
| quiet (bool): Suppress ``stderr`` output
| from the layout subprocess.
| engine: Layout engine for rendering
Expand Down
6 changes: 5 additions & 1 deletion graphviz/backend/dot_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
def command(engine: str, format_: str, *,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None
) -> typing.List[typing.Union[os.PathLike, str]]:
"""Return ``subprocess.Popen`` argument list for rendering.

Expand All @@ -41,4 +42,7 @@ def command(engine: str, format_: str, *,
if neato_no_op:
cmd.append(f'-n{neato_no_op:d}')

if invert_axis:
cmd.append('-y')

return cmd
20 changes: 16 additions & 4 deletions graphviz/backend/piping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ 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,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False) -> bytes:
"""Return ``data`` (``bytes``) piped through ``engine`` into ``format`` as ``bytes``.

Expand All @@ -26,6 +27,7 @@ def pipe(engine: str, format: str, data: bytes,
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
invert_axis: Invert the axis via the -y flag
quiet: Suppress ``stderr`` output from the layout subprocess.

Returns:
Expand Down Expand Up @@ -53,7 +55,8 @@ def pipe(engine: str, format: str, data: bytes,
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
neato_no_op=neato_no_op,
invert_axis=invert_axis)
kwargs = {'input': data}

proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
Expand All @@ -65,6 +68,7 @@ def pipe_string(engine: str, format: str, input_string: str, *,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False) -> str:
"""Return ``input_string`` piped through ``engine`` into ``format`` as string.

Expand All @@ -76,6 +80,7 @@ def pipe_string(engine: str, format: str, input_string: str, *,
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
invert_axis: Invert the axis via the -y flag
quiet: Suppress ``stderr`` output from the layout subprocess.

Returns:
Expand Down Expand Up @@ -104,7 +109,8 @@ def pipe_string(engine: str, format: str, input_string: str, *,
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
neato_no_op=neato_no_op,
invert_axis=invert_axis)
kwargs = {'input': input_string, 'encoding': encoding}

proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
Expand All @@ -116,6 +122,7 @@ def pipe_lines(engine: str, format: str, input_lines: typing.Iterator[str], *,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False) -> bytes:
r"""Return ``input_lines`` piped through ``engine`` into ``format`` as ``bytes``.

Expand All @@ -127,6 +134,7 @@ def pipe_lines(engine: str, format: str, input_lines: typing.Iterator[str], *,
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
invert_axis: Invert the axis via the -y flag
quiet: Suppress ``stderr`` output from the layout subprocess.

Returns:
Expand Down Expand Up @@ -155,7 +163,8 @@ def pipe_lines(engine: str, format: str, input_lines: typing.Iterator[str], *,
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
neato_no_op=neato_no_op,
invert_axis=invert_axis)
kwargs = {'input_lines': (line.encode(input_encoding) for line in input_lines)}

proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
Expand All @@ -167,6 +176,7 @@ def pipe_lines_string(engine: str, format: str, input_lines: typing.Iterator[str
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False) -> str:
r"""Return ``input_lines`` piped through ``engine`` into ``format`` as string.

Expand All @@ -178,6 +188,7 @@ def pipe_lines_string(engine: str, format: str, input_lines: typing.Iterator[str
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
invert_axis: Invert the axis via the -y flag
quiet: Suppress ``stderr`` output from the layout subprocess.

Returns:
Expand Down Expand Up @@ -206,7 +217,8 @@ def pipe_lines_string(engine: str, format: str, input_lines: typing.Iterator[str
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
neato_no_op=neato_no_op,
invert_axis=invert_axis)
kwargs = {'input_lines': input_lines, 'encoding': encoding}

proc = execute.run_check(cmd, capture_output=True, quiet=quiet, **kwargs)
Expand Down
8 changes: 7 additions & 1 deletion graphviz/backend/rendering.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ def render(engine: str,
renderer: typing.Optional[str] = ...,
formatter: typing.Optional[str] = ...,
neato_no_op: typing.Union[bool, int, None] = ...,
invert_axis: typing.Union[bool, None] = ...,
quiet: bool = ..., *,
outfile: typing.Union[os.PathLike, str, None] = ...,
raise_if_result_exists: bool = ...,
Expand All @@ -175,6 +176,7 @@ def render(engine: str,
renderer: typing.Optional[str] = ...,
formatter: typing.Optional[str] = ...,
neato_no_op: typing.Union[bool, int, None] = ...,
invert_axis: typing.Union[bool, None] = ...,
quiet: bool = False, *,
outfile: typing.Union[os.PathLike, str, None] = ...,
raise_if_result_exists: bool = ...,
Expand All @@ -189,6 +191,7 @@ def render(engine: str,
renderer: typing.Optional[str] = ...,
formatter: typing.Optional[str] = ...,
neato_no_op: typing.Union[bool, int, None] = ...,
invert_axis: typing.Union[bool, None] = ...,
quiet: bool = False, *,
outfile: typing.Union[os.PathLike, str, None] = ...,
raise_if_result_exists: bool = ...,
Expand All @@ -203,6 +206,7 @@ def render(engine: str,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False, *,
outfile: typing.Union[os.PathLike, str, None] = None,
raise_if_result_exists: bool = False,
Expand All @@ -220,6 +224,7 @@ def render(engine: str,
renderer: Output renderer (``'cairo'``, ``'gd'``, ...).
formatter: Output formatter (``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
invert_axis: Invert the axis via the -y flag
quiet: Suppress ``stderr`` output from the layout subprocess.
outfile: Path for the rendered output file.
raise_if_result_exits: Raise :exc:`graphviz.FileExistsError`
Expand Down Expand Up @@ -314,7 +319,8 @@ def render(engine: str,
cmd = dot_command.command(engine, format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op)
neato_no_op=neato_no_op,
invert_axis=invert_axis)

if raise_if_result_exists and os.path.exists(outfile):
raise exceptions.FileExistsError(f'output file exists: {os.fspath(outfile)!r}')
Expand Down
9 changes: 9 additions & 0 deletions graphviz/piping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ def pipe(self,
renderer: typing.Optional[str] = ...,
formatter: typing.Optional[str] = ...,
neato_no_op: typing.Union[bool, int, None] = ...,
invert_axis: typing.Union[bool, None] = ...,
quiet: bool = ..., *,
engine: typing.Optional[str] = ...,
encoding: None = ...) -> bytes:
Expand All @@ -36,6 +37,7 @@ def pipe(self,
renderer: typing.Optional[str] = ...,
formatter: typing.Optional[str] = ...,
neato_no_op: typing.Union[bool, int, None] = ...,
invert_axis: typing.Union[bool, None] = ...,
quiet: bool = ..., *,
engine: typing.Optional[str] = ...,
encoding: str) -> str:
Expand All @@ -47,6 +49,7 @@ def pipe(self,
renderer: typing.Optional[str] = ...,
formatter: typing.Optional[str] = ...,
neato_no_op: typing.Union[bool, int, None] = ...,
invert_axis: typing.Union[bool, None] = ...,
quiet: bool = ..., *,
engine: typing.Optional[str] = ...,
encoding: typing.Optional[str]) -> typing.Union[bytes, str]:
Expand All @@ -57,6 +60,7 @@ def pipe(self,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False, *,
engine: typing.Optional[str] = None,
encoding: typing.Optional[str] = None) -> typing.Union[bytes, str]:
Expand Down Expand Up @@ -105,6 +109,7 @@ def pipe(self,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op,
invert_axis=invert_axis,
quiet=quiet,
engine=engine,
encoding=encoding)
Expand All @@ -115,13 +120,15 @@ def _pipe_legacy(self,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False, *,
engine: typing.Optional[str] = None,
encoding: typing.Optional[str] = None) -> typing.Union[bytes, str]:
return self._pipe_future(format,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op,
invert_axis=invert_axis,
quiet=quiet,
engine=engine,
encoding=encoding)
Expand All @@ -130,6 +137,7 @@ def _pipe_future(self, format: typing.Optional[str] = None, *,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False,
engine: typing.Optional[str] = None,
encoding: typing.Optional[str] = None) -> typing.Union[bytes, str]:
Expand All @@ -138,6 +146,7 @@ def _pipe_future(self, format: typing.Optional[str] = None, *,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op,
invert_axis=invert_axis,
quiet=quiet,
verify=True)

Expand Down
3 changes: 3 additions & 0 deletions graphviz/rendering.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ def render(self,
renderer: typing.Optional[str] = None,
formatter: typing.Optional[str] = None,
neato_no_op: typing.Union[bool, int, None] = None,
invert_axis: typing.Union[bool, None] = None,
quiet: bool = False,
quiet_view: bool = False, *,
outfile: typing.Union[os.PathLike, str, None] = None,
Expand All @@ -51,6 +52,7 @@ def render(self,
formatter: The output formatter used for rendering
(``'cairo'``, ``'gd'``, ...).
neato_no_op: Neato layout engine no-op flag.
invert_axis: Invert the axis
quiet (bool): Suppress ``stderr`` output
from the layout subprocess.
quiet_view (bool): Suppress ``stderr`` output
Expand Down Expand Up @@ -106,6 +108,7 @@ def render(self,
renderer=renderer,
formatter=formatter,
neato_no_op=neato_no_op,
invert_axis=invert_axis,
quiet=quiet,
outfile=outfile,
raise_if_result_exists=raise_if_result_exists,
Expand Down
Loading