qtpy/cli.py

   1 # -----------------------------------------------------------------------------
   2 # Copyright © 2009- The QtPy Contributors
   3 #
   4 # Released under the terms of the MIT License
   5 # (see LICENSE.txt for details)
   6 # -----------------------------------------------------------------------------
   7
   8 """Provide a CLI to allow configuring developer settings, including mypy."""
   9
  10 # Standard library imports
  11 import argparse
  12 import json
  13 import textwrap
  14
  15
  16 def print_version():
  17     """Print the current version of the package."""
  18     import qtpy
  19
  20     print("QtPy version", qtpy.__version__)
  21
  22
  23 def get_api_status():
  24     """Get the status of each Qt API usage."""
  25     import qtpy
  26
  27     return {name: name == qtpy.API for name in qtpy.API_NAMES}
  28
  29
  30 def generate_mypy_args():
  31     """Generate a string with always-true/false args to pass to mypy."""
  32     options = {False: "--always-false", True: "--always-true"}
  33
  34     apis_active = get_api_status()
  35     return " ".join(
  36         f"{options[is_active]}={name.upper()}"
  37         for name, is_active in apis_active.items()
  38     )
  39
  40
  41 def generate_pyright_config_json():
  42     """Generate Pyright config to be used in `pyrightconfig.json`."""
  43     apis_active = get_api_status()
  44
  45     return json.dumps(
  46         {
  47             "defineConstant": {
  48                 name.upper(): is_active
  49                 for name, is_active in apis_active.items()
  50             },
  51         },
  52     )
  53
  54
  55 def generate_pyright_config_toml():
  56     """Generate a Pyright config to be used in `pyproject.toml`."""
  57     apis_active = get_api_status()
  58
  59     return "[tool.pyright.defineConstant]\n" + "\n".join(
  60         f"{name.upper()} = {str(is_active).lower()}"
  61         for name, is_active in apis_active.items()
  62     )
  63
  64
  65 def print_mypy_args():
  66     """Print the generated mypy args to stdout."""
  67     print(generate_mypy_args())
  68
  69
  70 def print_pyright_config_json():
  71     """Print the generated Pyright JSON config to stdout."""
  72     print(generate_pyright_config_json())
  73
  74
  75 def print_pyright_config_toml():
  76     """Print the generated Pyright TOML config to stdout."""
  77     print(generate_pyright_config_toml())
  78
  79
  80 def print_pyright_configs():
  81     """Print the generated Pyright configs to stdout."""
  82     print("pyrightconfig.json:")
  83     print_pyright_config_json()
  84     print()
  85     print("pyproject.toml:")
  86     print_pyright_config_toml()
  87
  88
  89 def generate_arg_parser():
  90     """Generate the argument parser for the dev CLI for QtPy."""
  91     parser = argparse.ArgumentParser(
  92         description="Features to support development with QtPy.",
  93     )
  94     parser.set_defaults(func=parser.print_help)
  95
  96     parser.add_argument(
  97         "--version",
  98         action="store_const",
  99         dest="func",
 100         const=print_version,
 101         help="If passed, will print the version and exit",
 102     )
 103
 104     cli_subparsers = parser.add_subparsers(
 105         title="Subcommands",
 106         help="Subcommand to run",
 107         metavar="Subcommand",
 108     )
 109
 110     # Parser for the MyPy args subcommand
 111     mypy_args_parser = cli_subparsers.add_parser(
 112         name="mypy-args",
 113         help="Generate command line arguments for using mypy with QtPy.",
 114         formatter_class=argparse.RawTextHelpFormatter,
 115         description=textwrap.dedent(
 116             """
 117             Generate command line arguments for using mypy with QtPy.
 118
 119             This will generate strings similar to the following
 120             which help guide mypy through which library QtPy would have used
 121             so that mypy can get the proper underlying type hints.
 122
 123                 --always-false=PYQT5 --always-false=PYQT6 --always-true=PYSIDE2 --always-false=PYSIDE6
 124
 125             It can be used as follows on Bash or a similar shell:
 126
 127                 mypy --package mypackage $(qtpy mypy-args)
 128             """,
 129         ),
 130     )
 131     mypy_args_parser.set_defaults(func=print_mypy_args)
 132
 133     # Parser for the Pyright config subcommand
 134     pyright_config_parser = cli_subparsers.add_parser(
 135         name="pyright-config",
 136         help="Generate Pyright config for using Pyright with QtPy.",
 137         formatter_class=argparse.RawTextHelpFormatter,
 138         description=textwrap.dedent(
 139             """
 140             Generate Pyright config for using Pyright with QtPy.
 141
 142             This will generate config sections to be included in a Pyright
 143             config file (either `pyrightconfig.json` or `pyproject.toml`)
 144             which help guide Pyright through which library QtPy would have used
 145             so that Pyright can get the proper underlying type hints.
 146
 147             """,
 148         ),
 149     )
 150     pyright_config_parser.set_defaults(func=print_pyright_configs)
 151
 152     return parser
 153
 154
 155 def main(args=None):
 156     """Run the development CLI for QtPy."""
 157     parser = generate_arg_parser()
 158     parsed_args = parser.parse_args(args=args)
 159
 160     reserved_params = {"func"}
 161     cleaned_args = {
 162         key: value
 163         for key, value in vars(parsed_args).items()
 164         if key not in reserved_params
 165     }
 166     parsed_args.func(**cleaned_args)