misc: rename Style to DocstringStyle

rr- · May 26, 2021 · 7a4334a · 7a4334a
1 parent ff9d937
commit 7a4334a
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 21 deletions.
diff --git a/docstring_parser/__init__.py b/docstring_parser/__init__.py
@@ -7,9 +7,10 @@
     DocstringParam,
     DocstringRaises,
     DocstringReturns,
-    ParseError,
-    Style,
 )
+from .common import DocstringStyle  # backwards compatibility
+from .common import DocstringStyle as Style
+from .common import ParseError
 from .parser import parse
 
 __all__ = [
@@ -21,5 +22,6 @@
     "DocstringRaises",
     "DocstringReturns",
     "DocstringDeprecated",
+    "DocstringStyle",
     "Style",
 ]
diff --git a/docstring_parser/common.py b/docstring_parser/common.py
@@ -20,7 +20,7 @@ class ParseError(RuntimeError):
     """Base class for all parsing related errors."""
 
 
-class Style(enum.Enum):
+class DocstringStyle(enum.Enum):
     """Docstring style."""
 
     rest = 1
@@ -123,15 +123,15 @@ class Docstring:
 
     def __init__(
         self,
-        style=None,  # type: T.Optional[Style]
+        style=None,  # type: T.Optional[DocstringStyle]
     ) -> None:
         """Initialize self."""
         self.short_description = None  # type: T.Optional[str]
         self.long_description = None  # type: T.Optional[str]
         self.blank_after_short_description = False
         self.blank_after_long_description = False
         self.meta = []  # type: T.List[DocstringMeta]
-        self.style = style  # type: T.Optional[Style]
+        self.style = style  # type: T.Optional[DocstringStyle]
 
     @property
     def params(self) -> T.List[DocstringParam]:

diff --git a/docstring_parser/google.py b/docstring_parser/google.py
@@ -16,8 +16,8 @@
     DocstringParam,
     DocstringRaises,
     DocstringReturns,
+    DocstringStyle,
     ParseError,
-    Style,
 )
 
 
@@ -187,7 +187,7 @@ def parse(self, text: str) -> Docstring:
 
         :returns: parsed docstring
         """
-        ret = Docstring(style=Style.google)
+        ret = Docstring(style=DocstringStyle.google)
         if not text:
             return ret
 

diff --git a/docstring_parser/numpydoc.py b/docstring_parser/numpydoc.py
@@ -15,7 +15,7 @@
     DocstringParam,
     DocstringRaises,
     DocstringReturns,
-    Style,
+    DocstringStyle,
 )
 
 
@@ -284,7 +284,7 @@ def parse(self, text: str) -> Docstring:
 
         :returns: parsed docstring
         """
-        ret = Docstring(style=Style.numpydoc)
+        ret = Docstring(style=DocstringStyle.numpydoc)
         if not text:
             return ret
 

diff --git a/docstring_parser/parser.py b/docstring_parser/parser.py
@@ -1,23 +1,23 @@
 """The main parsing routine."""
 
 from docstring_parser import google, numpydoc, rest
-from docstring_parser.common import Docstring, ParseError, Style
+from docstring_parser.common import Docstring, DocstringStyle, ParseError
 
 STYLES = {
-    Style.rest: rest.parse,
-    Style.google: google.parse,
-    Style.numpydoc: numpydoc.parse,
+    DocstringStyle.rest: rest.parse,
+    DocstringStyle.google: google.parse,
+    DocstringStyle.numpydoc: numpydoc.parse,
 }
 
 
-def parse(text: str, style: Style = Style.auto) -> Docstring:
+def parse(text: str, style: DocstringStyle = DocstringStyle.auto) -> Docstring:
     """Parse the docstring into its components.
 
     :param text: docstring text to parse
     :param style: docstring style
     :returns: parsed docstring representation
     """
-    if style != Style.auto:
+    if style != DocstringStyle.auto:
         return STYLES[style](text)
 
     rets = []

diff --git a/docstring_parser/rest.py b/docstring_parser/rest.py
@@ -14,8 +14,8 @@
     DocstringParam,
     DocstringRaises,
     DocstringReturns,
+    DocstringStyle,
     ParseError,
-    Style,
 )
 
 
@@ -89,7 +89,7 @@ def parse(text: str) -> Docstring:
 
     :returns: parsed docstring
     """
-    ret = Docstring(style=Style.rest)
+    ret = Docstring(style=DocstringStyle.rest)
     if not text:
         return ret
 

diff --git a/docstring_parser/tests/test_parser.py b/docstring_parser/tests/test_parser.py
@@ -1,4 +1,4 @@
-from docstring_parser.common import Style
+from docstring_parser.common import DocstringStyle
 from docstring_parser.parser import parse
 
 
@@ -21,7 +21,7 @@ def test_rest() -> None:
         """
     )
 
-    assert docstring.style == Style.rest
+    assert docstring.style == DocstringStyle.rest
     assert docstring.short_description == "Short description"
     assert docstring.long_description == (
         "Long description\n\n"
@@ -69,7 +69,7 @@ def test_google() -> None:
         """
     )
 
-    assert docstring.style == Style.google
+    assert docstring.style == DocstringStyle.google
     assert docstring.short_description == "Short description"
     assert docstring.long_description == (
         "Long description\n\n"
@@ -139,7 +139,7 @@ def test_numpydoc() -> None:
         """
     )
 
-    assert docstring.style == Style.numpydoc
+    assert docstring.style == DocstringStyle.numpydoc
     assert docstring.short_description == "Short description"
     assert docstring.long_description == (
         "Long description\n\n"