Update description for GitHub Action `options:` argument (GH-2858)

[etc/vim.git] / src / black_primer / cli.py

diff --git a/src/black_primer/cli.py b/src/black_primer/cli.py
index 010ea6c7af2e26ec5c23c609760bada411db6e23..8524b59a6322026b33fc77064ba9db91e1e19d42 100644 (file)
--- a/src/black_primer/cli.py
+++ b/src/black_primer/cli.py
@@ -1,19 +1,27 @@
-#!/usr/bin/env python3
+# coding=utf8

 
 import asyncio
 
 import asyncio

+import json

 import logging
 import sys
 from datetime import datetime
 import logging
 import sys
 from datetime import datetime

-from os import cpu_count

 from pathlib import Path
 from shutil import rmtree, which
 from tempfile import gettempdir
 from pathlib import Path
 from shutil import rmtree, which
 from tempfile import gettempdir

-from typing import Any, Union
+from typing import Any, List, Optional, Union

 
 import click
 
 from black_primer import lib
 
 
 import click
 
 from black_primer import lib
 

+# If our environment has uvloop installed lets use it
+try:
+    import uvloop
+
+    uvloop.install()
+except ImportError:
+    pass
+

 
 DEFAULT_CONFIG = Path(__file__).parent / "primer.json"
 _timestamp = datetime.now().strftime("%Y%m%d%H%M%S")
 
 DEFAULT_CONFIG = Path(__file__).parent / "primer.json"
 _timestamp = datetime.now().strftime("%Y%m%d%H%M%S")


@@ -22,8 +30,8 @@ LOG = logging.getLogger(__name__)
 
 
 def _handle_debug(
 
 
 def _handle_debug(

-    ctx: click.core.Context,
-    param: Union[click.core.Option, click.core.Parameter],
+    ctx: Optional[click.core.Context],
+    param: Optional[Union[click.core.Option, click.core.Parameter]],

     debug: Union[bool, int, str],
 ) -> Union[bool, int, str]:
     """Turn on debugging if asked otherwise INFO default"""
     debug: Union[bool, int, str],
 ) -> Union[bool, int, str]:
     """Turn on debugging if asked otherwise INFO default"""


@@ -35,11 +43,42 @@ def _handle_debug(
     return debug
 
 
     return debug
 
 

+def load_projects(config_path: Path) -> List[str]:
+    with open(config_path) as config:
+        return sorted(json.load(config)["projects"].keys())
+
+
+# Unfortunately does import time file IO - but appears to be the only
+# way to get `black-primer --help` to show projects list
+DEFAULT_PROJECTS = load_projects(DEFAULT_CONFIG)
+
+
+def _projects_callback(
+    ctx: click.core.Context,
+    param: Optional[Union[click.core.Option, click.core.Parameter]],
+    projects: str,
+) -> List[str]:
+    requested_projects = set(projects.split(","))
+    available_projects = set(
+        DEFAULT_PROJECTS
+        if str(DEFAULT_CONFIG) == ctx.params["config"]
+        else load_projects(ctx.params["config"])
+    )
+
+    unavailable = requested_projects - available_projects
+    if unavailable:
+        LOG.error(f"Projects not found: {unavailable}. Available: {available_projects}")
+
+    return sorted(requested_projects & available_projects)
+
+

 async def async_main(
     config: str,
     debug: bool,
     keep: bool,
     long_checkouts: bool,
 async def async_main(
     config: str,
     debug: bool,
     keep: bool,
     long_checkouts: bool,

+    no_diff: bool,
+    projects: List[str],

     rebase: bool,
     workdir: str,
     workers: int,
     rebase: bool,
     workdir: str,
     workers: int,


@@ -50,20 +89,26 @@ async def async_main(
         work_path.mkdir()
 
     if not which("black"):
         work_path.mkdir()
 
     if not which("black"):

-        LOG.error(f"Can not find 'black' executable in PATH. No point in running")
+        LOG.error("Can not find 'black' executable in PATH. No point in running")

         return -1
 
     try:
         ret_val = await lib.process_queue(
         return -1
 
     try:
         ret_val = await lib.process_queue(

-            config, work_path, workers, keep, long_checkouts, rebase
+            config,
+            work_path,
+            workers,
+            projects,
+            keep,
+            long_checkouts,
+            rebase,
+            no_diff,

         )
         return int(ret_val)
         )
         return int(ret_val)

+

     finally:
         if not keep and work_path.exists():
             LOG.debug(f"Removing {work_path}")
     finally:
         if not keep and work_path.exists():
             LOG.debug(f"Removing {work_path}")

-            rmtree(work_path)
-
-    return -1
+            rmtree(work_path, onerror=lib.handle_PermissionError)

 
 
 @click.command(context_settings={"help_option_names": ["-h", "--help"]})
 
 
 @click.command(context_settings={"help_option_names": ["-h", "--help"]})


@@ -74,6 +119,8 @@ async def async_main(
     type=click.Path(exists=True),
     show_default=True,
     help="JSON config file path",
     type=click.Path(exists=True),
     show_default=True,
     help="JSON config file path",

+    # Eager - because config path is used by other callback options
+    is_eager=True,

 )
 @click.option(
     "--debug",
 )
 @click.option(
     "--debug",


@@ -96,6 +143,19 @@ async def async_main(
     show_default=True,
     help="Pull big projects to test",
 )
     show_default=True,
     help="Pull big projects to test",
 )

+@click.option(
+    "--no-diff",
+    is_flag=True,
+    show_default=True,
+    help="Disable showing source file changes in black output",
+)
+@click.option(
+    "--projects",
+    default=",".join(DEFAULT_PROJECTS),
+    callback=_projects_callback,
+    show_default=True,
+    help="Comma separated list of projects to run",
+)

 @click.option(
     "-R",
     "--rebase",
 @click.option(
     "-R",
     "--rebase",


@@ -109,21 +169,21 @@ async def async_main(
     default=str(DEFAULT_WORKDIR),
     type=click.Path(exists=False),
     show_default=True,
     default=str(DEFAULT_WORKDIR),
     type=click.Path(exists=False),
     show_default=True,

-    help="Directory Path for repo checkouts",
+    help="Directory path for repo checkouts",

 )
 @click.option(
     "-W",
     "--workers",
 )
 @click.option(
     "-W",
     "--workers",

-    default=int((cpu_count() or 4) / 2) or 1,
+    default=2,

     type=int,
     show_default=True,
     help="Number of parallel worker coroutines",
 )
 @click.pass_context
 def main(ctx: click.core.Context, **kwargs: Any) -> None:
     type=int,
     show_default=True,
     help="Number of parallel worker coroutines",
 )
 @click.pass_context
 def main(ctx: click.core.Context, **kwargs: Any) -> None:

-    """primer - prime projects for blackening ... 🏴"""
+    """primer - prime projects for blackening... 🏴"""

     LOG.debug(f"Starting {sys.argv[0]}")
     LOG.debug(f"Starting {sys.argv[0]}")

-    # TODO: Change to asyncio.run when black >= 3.7 only
+    # TODO: Change to asyncio.run when Black >= 3.7 only

     loop = asyncio.get_event_loop()
     try:
         ctx.exit(loop.run_until_complete(async_main(**kwargs)))
     loop = asyncio.get_event_loop()
     try:
         ctx.exit(loop.run_until_complete(async_main(**kwargs)))


@@ -131,5 +191,5 @@ def main(ctx: click.core.Context, **kwargs: Any) -> None:
         loop.close()
 
 
         loop.close()
 
 

-if __name__ == "__main__":
+if __name__ == "__main__":  # pragma: nocover

     main()
     main()