intermediate changes

ref:614ed510ddd3cdf86a8c5dbf19afd113397e0172

1 files changed, 30 insertions, 22 deletions

diff --git a/contrib/python/pytest/py3/_pytest/_argcomplete.py b/contrib/python/pytest/py3/_pytest/_argcomplete.py
index 7ca216ecf96..41d9d9407c7 100644
--- a/contrib/python/pytest/py3/_pytest/_argcomplete.py
+++ b/contrib/python/pytest/py3/_pytest/_argcomplete.py
@@ -1,7 +1,8 @@
-"""allow bash-completion for argparse with argcomplete if installed
-needs argcomplete>=0.5.6 for python 3.2/3.3 (older versions fail
+"""Allow bash-completion for argparse with argcomplete if installed.
+
+Needs argcomplete>=0.5.6 for python 3.2/3.3 (older versions fail
 to find the magic string, so _ARGCOMPLETE env. var is never set, and
-this does not need special code.
+this does not need special code).
 
 Function try_argcomplete(parser) should be called directly before
 the call to ArgumentParser.parse_args().
@@ -10,8 +11,7 @@ The filescompleter is what you normally would use on the positional
 arguments specification, in order to get "dirname/" after "dirn<TAB>"
 instead of the default "dirname ":
 
-   optparser.add_argument(Config._file_or_dir, nargs='*'
-                               ).completer=filescompleter
+   optparser.add_argument(Config._file_or_dir, nargs='*').completer=filescompleter
 
 Other, application specific, completers should go in the file
 doing the add_argument calls as they need to be specified as .completer
@@ -20,35 +20,43 @@ attribute points to will not be used).
 
 SPEEDUP
 =======
+
 The generic argcomplete script for bash-completion
-(/etc/bash_completion.d/python-argcomplete.sh )
+(/etc/bash_completion.d/python-argcomplete.sh)
 uses a python program to determine startup script generated by pip.
 You can speed up completion somewhat by changing this script to include
   # PYTHON_ARGCOMPLETE_OK
-so the the python-argcomplete-check-easy-install-script does not
+so the python-argcomplete-check-easy-install-script does not
 need to be called to find the entry point of the code and see if that is
-marked  with PYTHON_ARGCOMPLETE_OK
+marked  with PYTHON_ARGCOMPLETE_OK.
 
 INSTALL/DEBUGGING
 =================
+
 To include this support in another application that has setup.py generated
 scripts:
-- add the line:
+
+- Add the line:
     # PYTHON_ARGCOMPLETE_OK
-  near the top of the main python entry point
-- include in the file calling parse_args():
+  near the top of the main python entry point.
+
+- Include in the file calling parse_args():
     from _argcomplete import try_argcomplete, filescompleter
-   , call try_argcomplete just before parse_args(), and optionally add
-   filescompleter to the positional arguments' add_argument()
+  Call try_argcomplete just before parse_args(), and optionally add
+  filescompleter to the positional arguments' add_argument().
+
 If things do not work right away:
-- switch on argcomplete debugging with (also helpful when doing custom
+
+- Switch on argcomplete debugging with (also helpful when doing custom
   completers):
     export _ARC_DEBUG=1
-- run:
+
+- Run:
     python-argcomplete-check-easy-install-script $(which appname)
     echo $?
-  will echo 0 if the magic line has been found, 1 if not
-- sometimes it helps to find early on errors using:
+  will echo 0 if the magic line has been found, 1 if not.
+
+- Sometimes it helps to find early on errors using:
     _ARGCOMPLETE=1 _ARC_DEBUG=1 appname
   which should throw a KeyError: 'COMPLINE' (which is properly set by the
   global argcomplete script).
@@ -63,13 +71,13 @@ from typing import Optional
 
 
 class FastFilesCompleter:
-    "Fast file completer class"
+    """Fast file completer class."""
 
     def __init__(self, directories: bool = True) -> None:
         self.directories = directories
 
     def __call__(self, prefix: str, **kwargs: Any) -> List[str]:
-        """only called on non option completions"""
+        # Only called on non option completions.
         if os.path.sep in prefix[1:]:
             prefix_dir = len(os.path.dirname(prefix) + os.path.sep)
         else:
@@ -77,7 +85,7 @@ class FastFilesCompleter:
         completion = []
         globbed = []
         if "*" not in prefix and "?" not in prefix:
-            # we are on unix, otherwise no bash
+            # We are on unix, otherwise no bash.
             if not prefix or prefix[-1] == os.path.sep:
                 globbed.extend(glob(prefix + ".*"))
             prefix += "*"
@@ -85,7 +93,7 @@ class FastFilesCompleter:
         for x in sorted(globbed):
             if os.path.isdir(x):
                 x += "/"
-            # append stripping the prefix (like bash, not like compgen)
+            # Append stripping the prefix (like bash, not like compgen).
             completion.append(x[prefix_dir:])
         return completion
 
@@ -95,7 +103,7 @@ if os.environ.get("_ARGCOMPLETE"):
         import argcomplete.completers
     except ImportError:
         sys.exit(-1)
-    filescompleter = FastFilesCompleter()  # type: Optional[FastFilesCompleter]
+    filescompleter: Optional[FastFilesCompleter] = FastFilesCompleter()
 
     def try_argcomplete(parser: argparse.ArgumentParser) -> None:
         argcomplete.autocomplete(parser, always_complete_options=False)