expose/document DotSyntaxWarning, standardize exception order

xflr6 · Apr 16, 2022 · 9a63a50 · 9a63a50
1 parent fc75da8
commit 9a63a50
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 15 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -9,9 +9,9 @@ API Reference
     graphviz.Source
     graphviz.escape
     graphviz.nohtml
-    graphviz.RequiredArgumentError
     graphviz.ExecutableNotFound
     graphviz.CalledProcessError
+    graphviz.RequiredArgumentError
     graphviz.render
     graphviz.pipe
     graphviz.pipe_string
@@ -92,12 +92,12 @@ Quoting/escaping
 Exceptions
 ----------
 
-.. autoexception:: graphviz.RequiredArgumentError
-
 .. autoexception:: graphviz.ExecutableNotFound
 
 .. autoexception:: graphviz.CalledProcessError
 
+.. autoexception:: graphviz.RequiredArgumentError
+
 .. autoexception:: graphviz.FileExistsError
 
 
@@ -108,6 +108,8 @@ Warnings
 
 .. autoexception:: graphviz.FormatSuffixMismatchWarning
 
+.. autoexception:: graphviz.DotSyntaxWarning
+
 
 Low-level functions
 -------------------

diff --git a/graphviz/__init__.py b/graphviz/__init__.py
@@ -31,10 +31,10 @@
 from .backend import (DOT_BINARY, UNFLATTEN_BINARY,
                       render, pipe, pipe_string, pipe_lines, pipe_lines_string,
                       unflatten, version, view)
-from .exceptions import (RequiredArgumentError, FileExistsError,
+from .exceptions import (ExecutableNotFound, CalledProcessError,
+                         RequiredArgumentError, FileExistsError,
                          UnknownSuffixWarning, FormatSuffixMismatchWarning,
-                         DotSyntaxWarning,
-                         ExecutableNotFound, CalledProcessError)
+                         DotSyntaxWarning)
 from .graphs import Graph, Digraph
 from .jupyter_integration import SUPPORTED_JUPYTER_FORMATS
 from .parameters import ENGINES, FORMATS, RENDERERS, FORMATTERS
@@ -49,10 +49,10 @@
            'escape', 'nohtml',
            'render', 'pipe', 'pipe_string', 'pipe_lines', 'pipe_lines_string',
            'unflatten', 'version', 'view',
+           'ExecutableNotFound', 'CalledProcessError',
            'RequiredArgumentError', 'FileExistsError',
            'UnknownSuffixWarning', 'FormatSuffixMismatchWarning',
            'DotSyntaxWarning',
-           'ExecutableNotFound', 'CalledProcessError',
            'set_default_engine', 'set_default_format', 'set_jupyter_format']
 
 __title__ = 'graphviz'
@@ -88,10 +88,16 @@
 """:class:`pathlib.Path` of unflatten command (``Path('unflatten')``)."""
 
 
+ExecutableNotFound = ExecutableNotFound
+
+
+CalledProcessError = CalledProcessError
+
+
 RequiredArgumentError = RequiredArgumentError
 
 
-ExecutableNotFound = ExecutableNotFound
+FileExistsError = FileExistsError
 
 
 UnknownSuffixWarning = UnknownSuffixWarning
@@ -100,7 +106,4 @@
 FormatSuffixMismatchWarning = FormatSuffixMismatchWarning
 
 
-CalledProcessError = CalledProcessError
-
-
-FileExistsError = FileExistsError
+DotSyntaxWarning = DotSyntaxWarning
diff --git a/graphviz/exceptions.py b/graphviz/exceptions.py
@@ -2,10 +2,10 @@
 
 from .backend.execute import ExecutableNotFound, CalledProcessError
 
-__all__ = ['RequiredArgumentError', 'FileExistsError',
+__all__ = ['ExecutableNotFound', 'CalledProcessError',
+           'RequiredArgumentError', 'FileExistsError',
            'UnknownSuffixWarning', 'FormatSuffixMismatchWarning',
-           'DotSyntaxWarning',
-           'ExecutableNotFound', 'CalledProcessError']
+           'DotSyntaxWarning']
 
 
 class RequiredArgumentError(TypeError):