Fixes from pydocstyle

Author: bluetech

src/_pytest/_argcomplete.py

@@ -71,7 +71,7 @@
 
 
 class FastFilesCompleter:
-    "Fast file completer class."
+    """Fast file completer class."""
 
     def __init__(self, directories: bool = True) -> None:
         self.directories = directories

src/_pytest/_code/code.py

@@ -411,7 +411,7 @@ def from_exc_info(
         exc_info: Tuple["Type[_E]", "_E", TracebackType],
         exprinfo: Optional[str] = None,
     ) -> "ExceptionInfo[_E]":
-        """Returns an ExceptionInfo for an existing exc_info tuple.
+        """Return an ExceptionInfo for an existing exc_info tuple.
 
         .. warning::
 
@@ -436,7 +436,7 @@ def from_exc_info(
     def from_current(
         cls, exprinfo: Optional[str] = None
     ) -> "ExceptionInfo[BaseException]":
-        """Returns an ExceptionInfo matching the current traceback.
+        """Return an ExceptionInfo matching the current traceback.
 
         .. warning::
 
@@ -1011,7 +1011,7 @@ class ReprEntry(TerminalRepr):
     style = attr.ib(type="_TracebackStyle")
 
     def _write_entry_lines(self, tw: TerminalWriter) -> None:
-        """Writes the source code portions of a list of traceback entries with syntax highlighting.
+        """Write the source code portions of a list of traceback entries with syntax highlighting.
 
         Usually entries are lines like these:
 

src/_pytest/assertion/rewrite.py

@@ -170,7 +170,7 @@ def exec_module(self, module: types.ModuleType) -> None:
         exec(co, module.__dict__)
 
     def _early_rewrite_bailout(self, name: str, state: "AssertionState") -> bool:
-        """This is a fast way to get out of rewriting modules.
+        """A fast way to get out of rewriting modules.
 
         Profiling has shown that the call to PathFinder.find_spec (inside of
         the find_spec from this class) is a major slowdown, so, this method
@@ -350,7 +350,7 @@ def _write_pyc(
 
 
 def _rewrite_test(fn: Path, config: Config) -> Tuple[os.stat_result, types.CodeType]:
-    """read and rewrite *fn* and return the code object."""
+    """Read and rewrite *fn* and return the code object."""
     fn_ = fspath(fn)
     stat = os.stat(fn_)
     with open(fn_, "rb") as f:
@@ -411,7 +411,7 @@ def rewrite_asserts(
 
 
 def _saferepr(obj: object) -> str:
-    """Get a safe repr of an object for assertion error messages.
+    r"""Get a safe repr of an object for assertion error messages.
 
     The assertion formatting (util.format_explanation()) requires
     newlines to be escaped since they are a special character for it.
@@ -424,7 +424,7 @@ def _saferepr(obj: object) -> str:
 
 
 def _format_assertmsg(obj: object) -> str:
-    """Format the custom assertion message given.
+    r"""Format the custom assertion message given.
 
     For strings this simply replaces newlines with '\n~' so that
     util.format_explanation() will preserve them instead of escaping
@@ -489,7 +489,7 @@ def _call_assertion_pass(lineno: int, orig: str, expl: str) -> None:
 
 
 def _check_if_assertion_pass_impl() -> bool:
-    """Checks if any plugins implement the pytest_assertion_pass hook
+    """Check if any plugins implement the pytest_assertion_pass hook
     in order not to generate explanation unecessarily (might be expensive)."""
     return True if util._assertion_pass else False
 
@@ -539,7 +539,7 @@ def _fix(node, lineno, col_offset):
 
 
 def _get_assertion_exprs(src: bytes) -> Dict[int, str]:
-    """Returns a mapping from {lineno: "assertion test expression"}."""
+    """Return a mapping from {lineno: "assertion test expression"}."""
     ret = {}  # type: Dict[int, str]
 
     depth = 0
@@ -1066,7 +1066,7 @@ def visit_Compare(self, comp: ast.Compare) -> Tuple[ast.expr, str]:
 
 
 def try_makedirs(cache_dir: Path) -> bool:
-    """Attempts to create the given directory and sub-directories exist.
+    """Attempt to create the given directory and sub-directories exist.
 
     Returns True if successful or if it already exists.
     """
@@ -1088,7 +1088,7 @@ def try_makedirs(cache_dir: Path) -> bool:
 
 
 def get_cache_dir(file_path: Path) -> Path:
-    """Returns the cache directory to write .pyc files for the given .py file path."""
+    """Return the cache directory to write .pyc files for the given .py file path."""
     if sys.version_info >= (3, 8) and sys.pycache_prefix:
         # given:
         #   prefix = '/tmp/pycs'

src/_pytest/assertion/truncate.py

@@ -1,5 +1,4 @@
-"""
-Utilities for truncating assertion output.
+"""Utilities for truncating assertion output.
 
 Current default behaviour is to truncate assertion explanations at
 ~8 terminal lines, unless running in "-vv" mode or running on CI.

src/_pytest/cacheprovider.py

@@ -70,7 +70,7 @@ def for_config(cls, config: Config) -> "Cache":
 
     @classmethod
     def clear_cache(cls, cachedir: Path) -> None:
-        """Clears the sub-directories used to hold cached directories and values."""
+        """Clear the sub-directories used to hold cached directories and values."""
         for prefix in (cls._CACHE_PREFIX_DIRS, cls._CACHE_PREFIX_VALUES):
             d = cachedir / prefix
             if d.is_dir():
@@ -263,7 +263,7 @@ def __init__(self, config: Config) -> None:
             )
 
     def get_last_failed_paths(self) -> Set[Path]:
-        """Returns a set with all Paths()s of the previously failed nodeids."""
+        """Return a set with all Paths()s of the previously failed nodeids."""
         rootpath = Path(str(self.config.rootdir))
         result = {rootpath / nodeid.split("::")[0] for nodeid in self.lastfailed}
         return {x for x in result if x.exists()}

src/_pytest/capture.py

@@ -458,7 +458,7 @@ def resume(self) -> None:
         self._state = "started"
 
     def writeorg(self, data):
-        """ write to original file descriptor. """
+        """Write to original file descriptor."""
         self._assert_state("writeorg", ("started", "suspended"))
         os.write(self.targetfd_save, data)
 

src/_pytest/compat.py

@@ -1,6 +1,4 @@
-"""
-python version compatibility code
-"""
+"""Python version compatibility code."""
 import enum
 import functools
 import inspect
@@ -143,13 +141,13 @@ def getfuncargnames(
     is_method: bool = False,
     cls: Optional[type] = None
 ) -> Tuple[str, ...]:
-    """Returns the names of a function's mandatory arguments.
+    """Return the names of a function's mandatory arguments.
 
-    This should return the names of all function arguments that:
-        * Aren't bound to an instance or type as in instance or class methods.
-        * Don't have default values.
-        * Aren't bound with functools.partial.
-        * Aren't replaced with mocks.
+    Should return the names of all function arguments that:
+    * Aren't bound to an instance or type as in instance or class methods.
+    * Don't have default values.
+    * Aren't bound with functools.partial.
+    * Aren't replaced with mocks.
 
     The is_method and cls arguments indicate that the function should
     be treated as a bound method even though it's not unless, only in

src/_pytest/config/__init__.py

@@ -1,4 +1,4 @@
-""" command line options, ini-file and conftest.py processing. """
+"""Command line options, ini-file and conftest.py processing."""
 import argparse
 import collections.abc
 import contextlib
@@ -173,7 +173,7 @@ def main(
 
 
 def console_main() -> int:
-    """pytest's CLI entry point.
+    """The CLI entry point of pytest.
 
     This function is not meant for programmable use; use `main()` instead.
     """
@@ -1354,11 +1354,11 @@ def getoption(self, name: str, default=notset, skip: bool = False):
             raise ValueError("no option named {!r}".format(name)) from e
 
     def getvalue(self, name: str, path=None):
-        """(deprecated, use getoption())"""
+        """Deprecated, use getoption() instead."""
         return self.getoption(name)
 
     def getvalueorskip(self, name: str, path=None):
-        """(deprecated, use getoption(skip=True))"""
+        """Deprecated, use getoption(skip=True) instead."""
         return self.getoption(name, skip=True)
 
     def _warn_about_missing_assertion(self, mode: str) -> None:

src/_pytest/config/argparsing.py

@@ -140,16 +140,15 @@ def parse_known_args(
         args: Sequence[Union[str, py.path.local]],
         namespace: Optional[argparse.Namespace] = None,
     ) -> argparse.Namespace:
-        """Parses and returns a namespace object with known arguments at this
-        point."""
+        """Parse and return a namespace object with known arguments at this point."""
         return self.parse_known_and_unknown_args(args, namespace=namespace)[0]
 
     def parse_known_and_unknown_args(
         self,
         args: Sequence[Union[str, py.path.local]],
         namespace: Optional[argparse.Namespace] = None,
     ) -> Tuple[argparse.Namespace, List[str]]:
-        """Parses and returns a namespace object with known arguments, and
+        """Parse and return a namespace object with known arguments, and
         the remaining arguments unknown at this point."""
         optparser = self._getparser()
         strargs = [str(x) if isinstance(x, py.path.local) else x for x in args]
@@ -402,7 +401,7 @@ def parse_args(  # type: ignore
         args: Optional[Sequence[str]] = None,
         namespace: Optional[argparse.Namespace] = None,
     ) -> argparse.Namespace:
-        """allow splitting of positional arguments"""
+        """Allow splitting of positional arguments."""
         parsed, unrecognized = self.parse_known_args(args, namespace)
         if unrecognized:
             for arg in unrecognized:

src/_pytest/debugging.py

@@ -1,4 +1,4 @@
-""" interactive debugging with PDB, the Python Debugger. """
+"""Interactive debugging with PDB, the Python Debugger."""
 import argparse
 import functools
 import sys
@@ -298,10 +298,10 @@ def pytest_pyfunc_call(self, pyfuncitem) -> Generator[None, None, None]:
 
 
 def wrap_pytest_function_for_tracing(pyfuncitem):
-    """Changes the python function object of the given Function item by a wrapper which actually
-    enters pdb before calling the python function itself, effectively leaving the user
-    in the pdb prompt in the first statement of the function.
-    """
+    """Change the Python function object of the given Function item by a
+    wrapper which actually enters pdb before calling the python function
+    itself, effectively leaving the user in the pdb prompt in the first
+    statement of the function."""
     _pdb = pytestPDB._init_pdb("runcall")
     testfunction = pyfuncitem.obj
 

src/_pytest/deprecated.py

@@ -1,5 +1,5 @@
-"""This module contains deprecation messages and bits of code used elsewhere
-in the codebase that is planned to be removed in the next pytest release.
+"""Deprecation messages and bits of code used elsewhere in the codebase that
+is planned to be removed in the next pytest release.
 
 Keeping it in a central location makes it easy to track what is deprecated and should
 be removed when the time comes.

src/_pytest/helpconfig.py

@@ -1,4 +1,4 @@
-""" version info, help messages, tracing configuration.  """
+"""Version info, help messages, tracing configuration."""
 import os
 import sys
 from argparse import Action

src/_pytest/hookspec.py

@@ -375,7 +375,7 @@ def pytest_make_parametrize_id(
 
 @hookspec(firstresult=True)
 def pytest_runtestloop(session: "Session") -> Optional[object]:
-    """Performs the main runtest loop (after collection finished).
+    """Perform the main runtest loop (after collection finished).
 
     The default hook implementation performs the runtest protocol for all items
     collected in the session (``session.items``), unless the collection failed
@@ -398,7 +398,7 @@ def pytest_runtestloop(session: "Session") -> Optional[object]:
 def pytest_runtest_protocol(
     item: "Item", nextitem: "Optional[Item]"
 ) -> Optional[object]:
-    """Performs the runtest protocol for a single test item.
+    """Perform the runtest protocol for a single test item.
 
     The default runtest protocol is this (see individual hooks for full details):
 

src/_pytest/junitxml.py

@@ -380,7 +380,7 @@ def test_foo(record_testsuite_property):
     __tracebackhide__ = True
 
     def record_func(name: str, value: object) -> None:
-        """noop function in case --junitxml was not passed in the command-line."""
+        """No-op function in case --junitxml was not passed in the command-line."""
         __tracebackhide__ = True
         _check_record_param_type("name", name)
 

src/_pytest/logging.py

@@ -317,7 +317,7 @@ class LogCaptureHandler(logging.StreamHandler):
     stream = None  # type: StringIO
 
     def __init__(self) -> None:
-        """Creates a new log handler."""
+        """Create a new log handler."""
         super().__init__(StringIO())
         self.records = []  # type: List[logging.LogRecord]
 
@@ -348,7 +348,7 @@ def __init__(self, item: nodes.Node) -> None:
         self._initial_logger_levels = {}  # type: Dict[Optional[str], int]
 
     def _finalize(self) -> None:
-        """Finalizes the fixture.
+        """Finalize the fixture.
 
         This restores the log levels changed by :meth:`set_level`.
         """
@@ -511,7 +511,7 @@ class LoggingPlugin:
     """Attaches to the logging module and captures log messages for each test."""
 
     def __init__(self, config: Config) -> None:
-        """Creates a new plugin to capture log messages.
+        """Create a new plugin to capture log messages.
 
         The formatter can be safely shared across all handlers so
         create a single one for the entire test session here.

src/_pytest/main.py

@@ -205,7 +205,7 @@ def validate_basetemp(path: str) -> str:
         raise argparse.ArgumentTypeError(msg)
 
     def is_ancestor(base: Path, query: Path) -> bool:
-        """ return True if query is an ancestor of base, else False."""
+        """Return whether query is an ancestor of base."""
         if base == query:
             return True
         for parent in base.parents:

src/_pytest/mark/structures.py

@@ -108,7 +108,8 @@ def extract_from(
         parameterset: Union["ParameterSet", Sequence[object], object],
         force_tuple: bool = False,
     ) -> "ParameterSet":
-        """
+        """Extract from an object or objects.
+
         :param parameterset:
             A legacy style parameterset that may or may not be a tuple,
             and may or may not be wrapped into a mess of mark objects.

src/_pytest/pathlib.py

@@ -126,7 +126,7 @@ def ensure_extended_length_path(path: Path) -> Path:
 
 
 def get_extended_length_path_str(path: str) -> str:
-    """Converts to extended length path as a str."""
+    """Convert a path to a Windows extended length path."""
     long_path_prefix = "\\\\?\\"
     unc_long_path_prefix = "\\\\?\\UNC\\"
     if path.startswith((long_path_prefix, unc_long_path_prefix)):
@@ -154,10 +154,10 @@ def find_prefixed(root: Path, prefix: str) -> Iterator[Path]:
 
 
 def extract_suffixes(iter: Iterable[PurePath], prefix: str) -> Iterator[str]:
-    """
+    """Return the parts of the paths following the prefix.
+
     :param iter: Iterator over path names.
     :param prefix: Expected prefix of the path names.
-    :returns: The parts of the paths following the prefix.
     """
     p_len = len(prefix)
     for p in iter:
@@ -283,7 +283,7 @@ def maybe_delete_a_numbered_dir(path: Path) -> None:
 
 
 def ensure_deletable(path: Path, consider_lock_dead_if_created_before: float) -> bool:
-    """checks if a lock exists and breaks it if its considered dead"""
+    """Check if a lock exists and breaks it if it's considered dead."""
     if path.is_symlink():
         return False
     lock = get_lock_path(path)
@@ -372,7 +372,7 @@ def resolve_from_str(input: str, root: py.path.local) -> Path:
 
 
 def fnmatch_ex(pattern: str, path) -> bool:
-    """FNMatcher port from py.path.common which works with PurePath() instances.
+    """A port of FNMatcher from py.path.common which works with PurePath() instances.
 
     The difference between this algorithm and PurePath.match() is that the
     latter matches "**" glob expressions for each part of the path, while