pylint fixes

Author: sumansaurabh

PyDocSmith/common.py

@@ -10,7 +10,7 @@
     "attribute",
     "key",
     "keyword",
-    "note"
+    "note",
 }
 RAISES_KEYWORDS = {"raises", "raise", "except", "exception"}
 DEPRECATION_KEYWORDS = {"deprecation", "deprecated"}
@@ -149,6 +149,7 @@ def __init__(
         self.snippet = snippet
         self.description = description
 
+
 class DocstringNote(DocstringMeta):
     """DocstringNote symbolizing example metadata."""
 
@@ -163,6 +164,7 @@ def __init__(
         self.snippet = snippet
         self.description = description
 
+
 class Docstring:
     """Docstring object representation."""
 
@@ -224,10 +226,8 @@ def examples(self) -> T.List[DocstringExample]:
         return [
             item for item in self.meta if isinstance(item, DocstringExample)
         ]
-    
+
     @property
     def notes(self) -> T.List[DocstringNote]:
         """Return a list of information on function notes."""
-        return [
-            item for item in self.meta if isinstance(item, DocstringNote)
-        ]
+        return [item for item in self.meta if isinstance(item, DocstringNote)]

PyDocSmith/epydoc.py

@@ -12,8 +12,6 @@
     DocstringParam,
     DocstringRaises,
     DocstringReturns,
-    DocstringExample,
-    DocstringNote,
     DocstringStyle,
     ParseError,
     RenderingStyle,

PyDocSmith/google.py

@@ -15,8 +15,8 @@
     YIELDS_KEYWORDS,
     Docstring,
     DocstringExample,
-    DocstringNote,
     DocstringMeta,
+    DocstringNote,
     DocstringParam,
     DocstringRaises,
     DocstringReturns,
@@ -105,27 +105,33 @@ def _build_meta(self, text: str, title: str) -> DocstringMeta:
         """
 
         section = self.sections[title]
-        pattern = r'^[\*_a-zA-Z\d]'
+        pattern = r"^[\*_a-zA-Z\d]"
         if text.strip() == "":
-            return
+            return None
 
         if (
             section.type == SectionType.SINGULAR_OR_MULTIPLE
             and not MULTIPLE_PATTERN.match(text)
         ) or section.type == SectionType.SINGULAR:
-            text = re.sub(r'^-\s', '', text)
-            #to validate if the text starts with a valid character in the function signature
+            text = re.sub(r"^-\s", "", text)
+            # to validate if the text starts with
+            # a valid character in the function signature
             valid_start_text_for_param = re.match(pattern, text)
 
-            #TODO: make better comparison for Examples
+            # TODO: make better comparison for Examples
             if not valid_start_text_for_param:
-                ignore_for_these_type = ["Example", "Examples", "Note", "Notes", "Returns", "Yields"]
+                ignore_for_these_type = [
+                    "Example",
+                    "Examples",
+                    "Note",
+                    "Notes",
+                ]
                 if not section.title in ignore_for_these_type:
-                    return
+                    return None
             return self._build_single_meta(section, text)
 
         if ":" not in text:
-            return
+            return None
 
         # Split spec and description
         before, desc = text.split(":", 1)
@@ -135,17 +141,17 @@ def _build_meta(self, text: str, title: str) -> DocstringMeta:
                 first_line, rest = desc.split("\n", 1)
                 desc = first_line + "\n" + inspect.cleandoc(rest)
             desc = desc.strip("\n")
-        
-        before = re.sub(r'^-\s', '', before)
-        
+
+        before = re.sub(r"^-\s", "", before)
+
         valid_start_text_for_param = re.match(pattern, before)
         if before and not valid_start_text_for_param:
-            return
-        
-        desc = re.sub(r'^-\s', '', desc)
+            return None
+
+        desc = re.sub(r"^-\s", "", desc)
         valid_start_text_for_param = re.match(pattern, before)
         if desc and not valid_start_text_for_param:
-            return
+            return None
         return self._build_multi_meta(section, before, desc)
 
     @staticmethod
@@ -276,7 +282,7 @@ def parse(self, text: str) -> Docstring:
             # Clear Any Unknown Meta
             # Ref: https://github.com/SigularityX-ai/PyDocSmith/issues/29
             meta_details = meta_chunk[start:end]
-            unknown_meta = re.search(r"\n\S", meta_details)
+            # unknown_meta = re.search(r"\n\S", meta_details)
             # if unknown_meta is not None:
             #     meta_details = meta_details[: unknown_meta.start()]
 
@@ -309,7 +315,7 @@ def parse(self, text: str) -> Docstring:
                 if not c_matches:
                     ret.meta.append(self._build_meta(part, title))
                     continue
-          
+
             if not c_matches:
                 raise ParseError(f'No specification for "{title}": "{chunk}"')
             c_splits = []
@@ -378,12 +384,15 @@ def process_one(
                 [head] + one.description.splitlines()
             )
             parts.append(body)
-        elif isinstance(one, DocstringReturns) and one.description and not one.type_name:
+        elif (
+            isinstance(one, DocstringReturns)
+            and one.description
+            and not one.type_name
+        ):
             (first, *rest) = one.description.splitlines()
             if rendering_style == RenderingStyle.COMPACT and first == "None":
                 index_of_returns = parts.index("Returns:")
                 parts.pop(index_of_returns)
-                pass
             else:
                 body = f"\n{indent}{indent}".join([head + first] + rest)
                 parts.append(body)

PyDocSmith/numpydoc.py

@@ -13,8 +13,8 @@
     Docstring,
     DocstringDeprecated,
     DocstringExample,
-    DocstringNote,
     DocstringMeta,
+    DocstringNote,
     DocstringParam,
     DocstringRaises,
     DocstringReturns,
@@ -263,6 +263,7 @@ def parse(self, text: str) -> T.Iterable[DocstringMeta]:
                 description="\n".join(description_lines),
             )
 
+
 class NotesSection(Section):
     """Parser for numpydoc notes sections.
 

PyDocSmith/parser.py

@@ -19,6 +19,7 @@
     DocstringStyle.EPYDOC: epydoc,
 }
 
+
 def detect_docstring_style(docstring) -> DocstringStyle:
     """
     Attempt to detect the docstring style based on simple heuristics.
@@ -27,15 +28,20 @@ def detect_docstring_style(docstring) -> DocstringStyle:
         docstring (str): The docstring to analyze.
 
     Returns:
-        str: The detected style ('REST', 'GOOGLE', 'NUMPYDOC', 'EPYDOC', or 'UNKNOWN').
+        str: The detected style ('REST', 'GOOGLE',
+        'NUMPYDOC', 'EPYDOC', or 'UNKNOWN').
     """
     if "@param" in docstring or "@return" in docstring:
         return DocstringStyle.EPYDOC
-    elif ":param:" in docstring or ":return:" in docstring or ":returns:" in docstring:
+    if (
+        ":param:" in docstring
+        or ":return:" in docstring
+        or ":returns:" in docstring
+    ):
         return DocstringStyle.REST
-    elif "Args:" in docstring or "Returns:" in docstring:
+    if "Args:" in docstring or "Returns:" in docstring:
         return DocstringStyle.GOOGLE
-    elif "Parameters" in docstring or "Returns" in docstring:
+    if "Parameters" in docstring or "Returns" in docstring:
         return DocstringStyle.NUMPYDOC
     return None
 
@@ -49,14 +55,14 @@ def parse(text: str, style: DocstringStyle = DocstringStyle.AUTO) -> Docstring:
     """
     if style != DocstringStyle.AUTO:
         return _STYLE_MAP[style].parse(text)
-    
+
     doc_string_style = detect_docstring_style(text)
 
     if doc_string_style is not None:
         try:
             return _STYLE_MAP[doc_string_style].parse(text)
-        except ParseError:
-            raise ParseError(f"Failed to parse docstring with style {doc_string_style}")
+        except ParseError as ex:
+            raise ex
 
     exc: T.Optional[Exception] = None
     rets = []