[style] Apply pydocstringformatter where it's not problematic

Author: Pierre-Sassoulas

astroid/__init__.py

@@ -2,7 +2,7 @@
 # For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt
 
-"""Python Abstract Syntax Tree New Generation
+"""Python Abstract Syntax Tree New Generation.
 
 The aim of this module is to provide a common base representation of
 python source code for projects such as pychecker, pyreverse,

astroid/_ast.py

@@ -51,7 +51,7 @@ def parse(self, string: str, type_comments: bool = True) -> ast.Module:
 
 
 def parse_function_type_comment(type_comment: str) -> FunctionType | None:
-    """Given a correct type comment, obtain a FunctionType object"""
+    """Given a correct type comment, obtain a FunctionType object."""
     if _ast_py3 is None:
         return None
 

astroid/astroid_manager.py

@@ -1,5 +1,7 @@
 """
-This file contain the global astroid MANAGER, to prevent circular import that happened
+This file contain the global astroid MANAGER, to prevent circular import that
+happened.
+
 when the only possibility to import it was from astroid.__init__.py.
 
 This AstroidManager is a singleton/borg so it's possible to instantiate an

astroid/brain/brain_boto3.py

@@ -2,7 +2,7 @@
 # For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt
 
-"""Astroid hooks for understanding boto3.ServiceRequest()"""
+"""Astroid hooks for understanding ``boto3.ServiceRequest()``."""
 from astroid import extract_node
 from astroid.manager import AstroidManager
 from astroid.nodes.scoped_nodes import ClassDef
@@ -11,7 +11,7 @@
 
 
 def service_request_transform(node):
-    """Transform ServiceResource to look like dynamic classes"""
+    """Transform ServiceResource to look like dynamic classes."""
     code = """
     def __getattr__(self, attr):
         return 0

astroid/brain/brain_collections.py

@@ -86,8 +86,8 @@ def __class_getitem__(cls, item): return cls"""
 
 def _looks_like_subscriptable(node: ClassDef) -> bool:
     """
-    Returns True if the node corresponds to a ClassDef of the Collections.abc module that
-    supports subscripting
+    Returns True if the node corresponds to a ClassDef of the Collections.abc module
+    that supports subscripting.
 
     :param node: ClassDef node
     """

astroid/brain/brain_ctypes.py

@@ -19,7 +19,9 @@
 
 def enrich_ctypes_redefined_types():
     """
-    For each ctypes redefined types, overload 'value' and '_type_' members definition.
+    For each ctypes redefined types, overload 'value' and '_type_' members
+    definition.
+
     Overloading 'value' is mandatory otherwise astroid cannot infer the correct type for it.
     Overloading '_type_' is necessary because the class definition made here replaces the original
     one, in which '_type_' member is defined. Luckily those original class definitions are very short

astroid/brain/brain_dateutil.py

@@ -2,7 +2,7 @@
 # For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt
 
-"""Astroid hooks for dateutil"""
+"""Astroid hooks for dateutil."""
 
 import textwrap
 

astroid/brain/brain_functools.py

@@ -137,7 +137,7 @@ def _looks_like_lru_cache(node) -> bool:
 
 
 def _looks_like_functools_member(node, member) -> bool:
-    """Check if the given Call node is a functools.partial call"""
+    """Check if the given Call node is a functools.partial call."""
     if isinstance(node.func, Name):
         return node.func.name == member
     if isinstance(node.func, Attribute):

astroid/brain/brain_hypothesis.py

@@ -15,7 +15,6 @@ def a_strategy(draw):
         return draw(st.integers())
 
     a_strategy()
-
 """
 from astroid.manager import AstroidManager
 from astroid.nodes.scoped_nodes import FunctionDef
@@ -39,7 +38,8 @@ def is_decorated_with_st_composite(node) -> bool:
 
 def remove_draw_parameter_from_composite_strategy(node):
     """Given that the FunctionDef is decorated with @st.composite, remove the
-    first argument (`draw`) - it's always supplied by Hypothesis so we don't
+    first argument (`draw`) - it's always supplied by Hypothesis so we don't.
+
     need to emit the no-value-for-parameter lint.
     """
     del node.args.args[0]

astroid/brain/brain_io.py

@@ -13,7 +13,9 @@
 
 
 def _generic_io_transform(node, name, cls):
-    """Transform the given name, by adding the given *class* as a member of the node."""
+    """Transform the given name, by adding the given *class* as a member of the
+    node.
+    """
 
     io_module = AstroidManager().ast_from_module_name("_io")
     attribute_object = io_module[cls]

astroid/brain/brain_numpy_core_einsumfunc.py

@@ -4,7 +4,7 @@
 
 """
 Astroid hooks for numpy.core.einsumfunc module:
-https://github.com/numpy/numpy/blob/main/numpy/core/einsumfunc.py
+https://github.com/numpy/numpy/blob/main/numpy/core/einsumfunc.py.
 """
 
 from astroid import nodes

astroid/brain/brain_numpy_utils.py

@@ -2,7 +2,7 @@
 # For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt
 
-"""Different utilities for the numpy brains"""
+"""Different utilities for the numpy brains."""
 
 from __future__ import annotations
 
@@ -15,17 +15,16 @@
 
 
 def numpy_supports_type_hints() -> bool:
-    """
-    Returns True if numpy supports type hints
-    """
+    """Returns True if numpy supports type hints."""
     np_ver = _get_numpy_version()
     return np_ver and np_ver > NUMPY_VERSION_TYPE_HINTS_SUPPORT
 
 
 def _get_numpy_version() -> tuple[str, str, str]:
     """
-    Return the numpy version number if numpy can be imported. Otherwise returns
-    ('0', '0', '0')
+    Return the numpy version number if numpy can be imported.
+
+    Otherwise returns ('0', '0', '0')
     """
     try:
         import numpy  # pylint: disable=import-outside-toplevel

astroid/brain/brain_re.py

@@ -75,7 +75,10 @@ def _looks_like_pattern_or_match(node: nodes.Call) -> bool:
 
 
 def infer_pattern_match(node: nodes.Call, ctx: context.InferenceContext | None = None):
-    """Infer re.Pattern and re.Match as classes. For PY39+ add `__class_getitem__`."""
+    """Infer re.Pattern and re.Match as classes.
+
+    For PY39+ add `__class_getitem__`.
+    """
     class_def = nodes.ClassDef(
         name=node.parent.targets[0].name,
         lineno=node.lineno,

astroid/brain/brain_responses.py

@@ -9,7 +9,6 @@
 :class:`responses.RequestsMock`.
 
 See: https://github.com/getsentry/responses/blob/master/responses.py
-
 """
 from astroid.brain.helpers import register_module_extender
 from astroid.builder import parse

astroid/brain/brain_six.py

@@ -167,7 +167,7 @@ def _looks_like_decorated_with_six_add_metaclass(node) -> bool:
 
 
 def transform_six_add_metaclass(node):  # pylint: disable=inconsistent-return-statements
-    """Check if the given class node is decorated with *six.add_metaclass*
+    """Check if the given class node is decorated with *six.add_metaclass*.
 
     If so, inject its argument as the metaclass of the underlying class.
     """
@@ -213,7 +213,7 @@ def _looks_like_nested_from_six_with_metaclass(node) -> bool:
 
 
 def transform_six_with_metaclass(node):
-    """Check if the given class node is defined with *six.with_metaclass*
+    """Check if the given class node is defined with *six.with_metaclass*.
 
     If so, inject its argument as the metaclass of the underlying class.
     """

astroid/brain/brain_type.py

@@ -31,7 +31,7 @@
 
 def _looks_like_type_subscript(node) -> bool:
     """
-    Try to figure out if a Name node is used inside a type related subscript
+    Try to figure out if a Name node is used inside a type related subscript.
 
     :param node: node to check
     :type node: astroid.nodes.node_classes.NodeNG
@@ -44,7 +44,7 @@ def _looks_like_type_subscript(node) -> bool:
 
 def infer_type_sub(node, context: InferenceContext | None = None):
     """
-    Infer a type[...] subscript
+    Infer a type[...] subscript.
 
     :param node: node to infer
     :type node: astroid.nodes.node_classes.NodeNG

astroid/brain/brain_unittest.py

@@ -2,7 +2,7 @@
 # For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt
 
-"""Astroid hooks for unittest module"""
+"""Astroid hooks for unittest module."""
 from astroid.brain.helpers import register_module_extender
 from astroid.builder import parse
 from astroid.const import PY38_PLUS
@@ -11,9 +11,11 @@
 
 def IsolatedAsyncioTestCaseImport():
     """
-    In the unittest package, the IsolatedAsyncioTestCase class is imported lazily, i.e only
-    when the __getattr__ method of the unittest module is called with 'IsolatedAsyncioTestCase' as
-    argument. Thus the IsolatedAsyncioTestCase is not imported statically (during import time).
+    In the unittest package, the IsolatedAsyncioTestCase class is imported lazily.
+
+    I.E. only when the ``__getattr__`` method of the unittest module is called with
+    'IsolatedAsyncioTestCase' as argument. Thus the IsolatedAsyncioTestCase
+    is not imported statically (during import time).
     This function mocks a classical static import of the IsolatedAsyncioTestCase.
 
     (see https://github.com/PyCQA/pylint/issues/4060)

astroid/exceptions.py

@@ -2,8 +2,7 @@
 # For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt
 
-"""this module contains exceptions used in the astroid library
-"""
+"""This module contains exceptions used in the astroid library."""
 
 from __future__ import annotations
 
@@ -49,7 +48,7 @@
 
 
 class AstroidError(Exception):
-    """base exception class for all astroid related exceptions
+    """Base exception class for all astroid related exceptions.
 
     AstroidError and its subclasses are structured, intended to hold
     objects representing state when the exception is thrown.  Field
@@ -73,7 +72,7 @@ def __str__(self) -> str:
 
 
 class AstroidBuildingError(AstroidError):
-    """exception class when we are unable to build an astroid representation
+    """Exception class when we are unable to build an astroid representation.
 
     Standard attributes:
         modname: Name of the module that AST construction failed for.
@@ -140,8 +139,8 @@ def __init__(
 
 
 class NoDefault(AstroidError):
-    """raised by function's `default_value` method when an argument has
-    no default value
+    """Raised by function's `default_value` method when an argument has
+    no default value.
 
     Standard attributes:
         func: Function node.
@@ -228,7 +227,7 @@ def __str__(self) -> str:
 
 
 class InferenceError(ResolveError):  # pylint: disable=too-many-instance-attributes
-    """raised when we are unable to infer a node
+    """Raised when we are unable to infer a node.
 
     Standard attributes:
         node: The node inference was called on.
@@ -332,13 +331,15 @@ def __init__(
 
 
 class UseInferenceDefault(Exception):
-    """exception to be raised in custom inference function to indicate that it
-    should go back to the default behaviour
+    """Exception to be raised in custom inference function to indicate that it
+    should go back to the default behaviour.
     """
 
 
 class _NonDeducibleTypeHierarchy(Exception):
-    """Raised when is_subtype / is_supertype can't deduce the relation between two types."""
+    """Raised when is_subtype / is_supertype can't deduce the relation between two
+    types.
+    """
 
 
 class AstroidIndexError(AstroidError):
@@ -380,14 +381,14 @@ class AstroidValueError(AstroidError):
 
 
 class InferenceOverwriteError(AstroidError):
-    """Raised when an inference tip is overwritten
+    """Raised when an inference tip is overwritten.
 
     Currently only used for debugging.
     """
 
 
 class ParentMissingError(AstroidError):
-    """Raised when a node which is expected to have a parent attribute is missing one
+    """Raised when a node which is expected to have a parent attribute is missing one.
 
     Standard attributes:
         target: The node for which the parent lookup failed.
@@ -399,7 +400,9 @@ def __init__(self, target: nodes.NodeNG) -> None:
 
 
 class StatementMissing(ParentMissingError):
-    """Raised when a call to node.statement() does not return a node. This is because
+    """Raised when a call to node.statement() does not return a node.
+
+    This is because
     a node in the chain does not have a parent attribute and therefore does not
     return a node for statement().
 

astroid/inference_tip.py

@@ -2,7 +2,7 @@
 # For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt
 
-"""Transform utilities (filters and decorator)"""
+"""Transform utilities (filters and decorator)."""
 
 from __future__ import annotations
 
@@ -32,7 +32,7 @@ def clear_inference_tip_cache() -> None:
 def _inference_tip_cached(
     func: InferFn, instance: None, args: typing.Any, kwargs: typing.Any
 ) -> Iterator[InferOptions]:
-    """Cache decorator used for inference tips"""
+    """Cache decorator used for inference tips."""
     node = args[0]
     try:
         result = _cache[func, node]

astroid/interpreter/_import/spec.py

@@ -44,7 +44,7 @@ class ModuleType(enum.Enum):
 
 
 class ModuleSpec(NamedTuple):
-    """Defines a class similar to PEP 420's ModuleSpec
+    """Defines a class similar to PEP 420's ModuleSpec.
 
     A module spec defines a name of a module, its type, location
     and where submodules can be found, if the module is a package.
@@ -71,7 +71,7 @@ def find_module(
         processed: list[str],
         submodule_path: Sequence[str] | None,
     ) -> ModuleSpec | None:
-        """Find the given module
+        """Find the given module.
 
         Each finder is responsible for each protocol of finding, as long as
         they all return a ModuleSpec.