Add shell completions by shtab

See #1992

pytest --print-completion bash | sudo tee /usr/share/bash-completion/completions/pytest
pytest --print-completion tcsh | sudo tee /etc/profile.d/pytest.completion.csh
pytest --print-completion zsh | sudo tee /usr/share/zsh/site-functions/_pytest

Author: Freed-Wu

AUTHORS

@@ -479,6 +479,7 @@ Will Riley
 William Lee
 Wim Glenn
 Wouter van Ackooy
+Wu Zhenyu
 Xixi Zhao
 Xuan Luong
 Xuecong Liao

changelog/10304.feature.rst

@@ -0,0 +1 @@
+Added shell completions by shtab

setup.cfg

@@ -0,0 +1,107 @@
+[metadata]
+name = pytest
+description = pytest: simple powerful testing with Python
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+url = https://docs.pytest.org/en/latest/
+author = Holger Krekel, Bruno Oliveira, Ronny Pfannschmidt, Floris Bruynooghe, Brianna Laugher, Florian Bruhin and others
+license = MIT
+license_file = LICENSE
+platforms = unix, linux, osx, cygwin, win32
+classifiers =
+    Development Status :: 6 - Mature
+    Intended Audience :: Developers
+    License :: OSI Approved :: MIT License
+    Operating System :: MacOS :: MacOS X
+    Operating System :: Microsoft :: Windows
+    Operating System :: POSIX
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Topic :: Software Development :: Libraries
+    Topic :: Software Development :: Testing
+    Topic :: Utilities
+keywords = test, unittest
+project_urls =
+    Changelog=https://docs.pytest.org/en/stable/changelog.html
+    Twitter=https://twitter.com/pytestdotorg
+    Source=https://github.com/pytest-dev/pytest
+    Tracker=https://github.com/pytest-dev/pytest/issues
+
+[options]
+packages =
+    _pytest
+    _pytest._code
+    _pytest._io
+    _pytest.assertion
+    _pytest.config
+    _pytest.mark
+    pytest
+install_requires =
+    attrs>=19.2.0
+    iniconfig
+    packaging
+    pluggy>=0.12,<2.0
+    py>=1.8.2
+    colorama;sys_platform=="win32"
+    exceptiongroup>=1.0.0rc8;python_version<"3.11"
+    importlib-metadata>=0.12;python_version<"3.8"
+    tomli>=1.0.0;python_version<"3.11"
+python_requires = >=3.7
+package_dir =
+    =src
+setup_requires =
+    setuptools
+    setuptools-scm>=6.0
+zip_safe = no
+
+[options.entry_points]
+console_scripts =
+    pytest=pytest:console_main
+    py.test=pytest:console_main
+
+[options.extras_require]
+completion =
+    shtab
+testing =
+    argcomplete
+    hypothesis>=3.56
+    mock
+    nose
+    pygments>=2.7.2
+    requests
+    shtab
+    xmlschema
+
+[options.package_data]
+_pytest = py.typed
+pytest = py.typed
+
+[build_sphinx]
+source_dir = doc/en/
+build_dir = doc/build
+all_files = 1
+
+[check-manifest]
+ignore =
+    src/_pytest/_version.py
+
+[devpi:upload]
+formats = sdist.tgz,bdist_wheel
+
+[mypy]
+mypy_path = src
+check_untyped_defs = True
+disallow_any_generics = True
+ignore_missing_imports = True
+no_implicit_optional = True
+show_error_codes = True
+strict_equality = True
+warn_redundant_casts = True
+warn_return_any = True
+warn_unreachable = True
+warn_unused_configs = True
+no_implicit_reexport = True

src/_pytest/__init__.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 
-__all__ = ["__version__", "version_tuple"]
+__all__ = ["__version__", "version_tuple", "shtab", "XML_FILE", "PREAMBLE"]
 
 try:
     from ._version import version as __version__
@@ -11,3 +11,24 @@
     # unknown only works because we do poor mans version compare
     __version__ = "unknown"
     version_tuple = (0, 0, "unknown")
+
+try:
+    import shtab
+except ImportError:
+    from . import _shtab as shtab
+
+# https://github.com/iterative/shtab/blob/5358dda86e8ea98bf801a43a24ad73cd9f820c63/examples/customcomplete.py#L11-L22
+XML_FILE = {
+    "bash": "_shtab_greeter_compgen_xml_files",
+    "zsh": "_files -g '*.xml'",
+    "tcsh": "f:*.xml",
+}
+PREAMBLE = {
+    "bash": """
+# $1=COMP_WORDS[1]
+_shtab_greeter_compgen_xml_files() {
+  compgen -d -- $1  # recurse into subdirs
+  compgen -f -X '!*?.xml' -- $1
+}
+"""
+}

src/_pytest/_shtab.py

@@ -0,0 +1,14 @@
+"""A shim of shtab."""
+from argparse import Action
+from argparse import ArgumentParser
+from typing import Any
+from typing import Dict
+from typing import List
+
+FILE = None
+DIRECTORY = DIR = None
+
+
+def add_argument_to(parser: ArgumentParser, *args: List[Any], **kwargs: Dict[str, Any]):
+    Action.complete = None  # type: ignore
+    return parser

src/_pytest/config/argparsing.py

@@ -13,10 +13,13 @@
 from typing import NoReturn
 
 import _pytest._io
+from _pytest import PREAMBLE
+from _pytest import shtab
 from _pytest.config.exceptions import UsageError
 from _pytest.deprecated import check_ispytest
 
 
+
 FILE_OR_DIR = "file_or_dir"
 
 
@@ -122,11 +125,19 @@ def _getparser(self) -> MyOptionParser:
             if group.options:
                 desc = group.description or group.name
                 arggroup = optparser.add_argument_group(desc)
+                if group.name == "debugconfig":
+                    shtab.add_argument_to(arggroup, preamble=PREAMBLE)
                 for option in group.options:
                     n = option.names()
                     a = option.attrs()
-                    arggroup.add_argument(*n, **a)
+                    complete = a.get("complete")
+                    if complete:
+                        del a["complete"]  # type: ignore
+                    action = arggroup.add_argument(*n, **a)
+                    if complete:
+                        action.complete = complete  # type: ignore
         file_or_dir_arg = optparser.add_argument(FILE_OR_DIR, nargs="*")
+        file_or_dir_arg.complete = shtab.FILE  # type: ignore
         # bash like autocompletion for dirs (appending '/')
         # Type ignored because typeshed doesn't know about argcomplete.
         file_or_dir_arg.completer = filescompleter  # type: ignore

src/_pytest/helpconfig.py

@@ -8,6 +8,7 @@
 import os
 import sys
 
+from _pytest import shtab
 from _pytest.config import Config
 from _pytest.config import ExitCode
 from _pytest.config import PrintHelp
@@ -96,6 +97,7 @@ def pytest_addoption(parser: Parser) -> None:
         help="Store internal tracing debug information in this log file. "
         "This file is opened with 'w' and truncated as a result, care advised. "
         "Default: pytestdebug.log.",
+        complete=shtab.FILE,
     )
     group._addoption(  # private to use reserved lower-case short option
         "-o",

src/_pytest/junitxml.py

@@ -17,6 +17,7 @@
 import re
 import xml.etree.ElementTree as ET
 
+from . import XML_FILE
 from _pytest import nodes
 from _pytest import timing
 from _pytest._code.code import ExceptionRepr
@@ -30,7 +31,6 @@
 from _pytest.terminal import TerminalReporter
 import pytest
 
-
 xml_key = StashKey["LogXML"]()
 
 
@@ -384,6 +384,7 @@ def pytest_addoption(parser: Parser) -> None:
         type=functools.partial(filename_arg, optname="--junitxml"),
         default=None,
         help="Create junit-xml style report file at given path",
+        complete=XML_FILE,
     )
     group.addoption(
         "--junitprefix",

src/_pytest/logging.py

@@ -26,6 +26,7 @@
 from typing import TypeVar
 
 from _pytest import nodes
+from _pytest import shtab
 from _pytest._io import TerminalWriter
 from _pytest.capture import CaptureManager
 from _pytest.config import _strtobool
@@ -294,6 +295,7 @@ def add_option_ini(option, dest, default=None, type=None, **kwargs):
         dest="log_file",
         default=None,
         help="Path to a file when logging will be written to",
+        complete=shtab.FILE,
     )
     add_option_ini(
         "--log-file-mode",

src/_pytest/main.py

@@ -26,6 +26,7 @@
 
 from _pytest import nodes
 import _pytest._code
+from _pytest import shtab
 from _pytest.config import Config
 from _pytest.config import directory_arg
 from _pytest.config import ExitCode
@@ -143,6 +144,7 @@ def pytest_addoption(parser: Parser) -> None:
         metavar="dir",
         type=functools.partial(directory_arg, optname="--confcutdir"),
         help="Only load conftest.py's relative to specified dir",
+        complete=shtab.DIR,
     )
     group.addoption(
         "--noconftest",
@@ -226,6 +228,7 @@ def pytest_addoption(parser: Parser) -> None:
         dest="inifilename",
         help="Load configuration from `FILE` instead of trying to locate one of the "
         "implicit configuration files.",
+        complete=shtab.FILE,
     )
     group.addoption(
         "--rootdir",
@@ -234,6 +237,7 @@ def pytest_addoption(parser: Parser) -> None:
         help="Define root directory for tests. Can be relative path: 'root_dir', './root_dir', "
         "'root_dir/another_dir/'; absolute path: '/home/user/root_dir'; path with variables: "
         "'$HOME/root_dir'.",
+        complete=shtab.DIR,
     )
     group.addoption(
         "--basetemp",
@@ -245,6 +249,7 @@ def pytest_addoption(parser: Parser) -> None:
             "Base temporary directory for this test run. "
             "(Warning: this directory is removed if it exists.)"
         ),
+        complete=shtab.DIR,
     )