Replace individual host options with --hosts

Author: jwodder

.github/workflows/update-gin.yml

@@ -27,7 +27,7 @@ jobs:
 
       - name: Run script
         # No space between `-e` and `run` or tox gets confused
-        run: tox -erun -- -l DEBUG --gin --hub-datalad-org --atris
+        run: tox -erun -- -l DEBUG --hosts gin,hub.datalad.org,atris
         env:
           GIN_TOKEN: ${{ secrets.GIN_TOKEN }}
           HUB_DATALAD_ORG_TOKEN: ${{ secrets.HUB_DATALAD_ORG_TOKEN }}

.github/workflows/update.yml

@@ -27,7 +27,7 @@ jobs:
 
       - name: Run script
         # No space between `-e` and `run` or tox gets confused
-        run: tox -erun -- -l DEBUG --github --osf
+        run: tox -erun -- -l DEBUG --hosts github,osf
         env:
           GITHUB_TOKEN: ${{ secrets.SEARCH_GITHUB_TOKEN }}
 

src/find_datalad_repos/__main__.py

@@ -2,6 +2,7 @@
 import json
 import logging
 import os
+import re
 import click
 from click_loglevel import LogLevel
 from ghtoken import get_ghtoken
@@ -12,72 +13,50 @@
 from .util import commit, runcmd
 
 
-def set_mode(
-    ctx: click.Context, _param: click.Parameter, value: RepoHost | None
-) -> RepoHost | None:
-    if value is not None:
-        ctx.params.setdefault("mode", set()).add(value)
-    return value
+class RepoHostSet(click.ParamType):
+    name = "hostset"
+
+    def convert(
+        self,
+        value: str | set[RepoHost],
+        param: click.Parameter | None,
+        ctx: click.Context | None,
+    ) -> set[RepoHost]:
+        if not isinstance(value, str):
+            return value
+        selected = set()
+        for v in re.split(r"\s*,\s*", value):
+            try:
+                selected.add(RepoHost(v))
+            except ValueError:
+                self.fail(f"{value!r}: invalid item {v!r}", param, ctx)
+        return selected
+
+    def get_metavar(self, _param: click.Parameter) -> str:
+        return "[all," + ",".join(v.value for v in RepoHost) + "]"
 
 
 @click.command()
+@click.option(
+    "--hosts",
+    type=RepoHostSet(),
+    default="all",
+    help="Set which repository hosts to query",
+)
 @click.option(
     "-l",
     "--log-level",
     type=LogLevel(),
     default=logging.INFO,
     help="Set logging level  [default: INFO]",
 )
-@click.option(
-    "--atris",
-    flag_value=RepoHost.ATRIS,
-    type=click.UNPROCESSED,
-    callback=set_mode,
-    expose_value=False,
-    help="Update ATRIS data",
-)
-@click.option(
-    "--gin",
-    flag_value=RepoHost.GIN,
-    type=click.UNPROCESSED,
-    callback=set_mode,
-    expose_value=False,
-    help="Update GIN data",
-)
-@click.option(
-    "--github",
-    flag_value=RepoHost.GITHUB,
-    type=click.UNPROCESSED,
-    callback=set_mode,
-    expose_value=False,
-    help="Update GitHub data",
-)
-@click.option(
-    "--hub-datalad-org",
-    flag_value=RepoHost.HUB_DATALAD_ORG,
-    type=click.UNPROCESSED,
-    callback=set_mode,
-    expose_value=False,
-    help="Update hub.datalad.org data",
-)
-@click.option(
-    "--osf",
-    flag_value=RepoHost.OSF,
-    type=click.UNPROCESSED,
-    callback=set_mode,
-    expose_value=False,
-    help="Update OSF data",
-)
 @click.option(
     "-R",
     "--regen-readme",
     is_flag=True,
     help="Regenerate the README from the JSON file without querying",
 )
-def main(log_level: int, regen_readme: bool, mode: set[RepoHost] | None = None) -> None:
-    if regen_readme and mode:
-        raise click.UsageError("--regen-readme is mutually exclusive with mode options")
-
+def main(log_level: int, regen_readme: bool, hosts: set[RepoHost]) -> None:
     logging.basicConfig(
         format="%(asctime)s [%(levelname)-8s] %(name)s %(message)s",
         datefmt="%Y-%m-%dT%H:%M:%S%z",
@@ -91,20 +70,18 @@ def main(log_level: int, regen_readme: bool, mode: set[RepoHost] | None = None)
         record = RepoRecord()
 
     reports: list[str] = []
-    if mode is None:
-        mode = set(RepoHost)
     if not regen_readme:
-        if RepoHost.GITHUB in mode:
+        if RepoHost.GITHUB in hosts:
             reports.extend(record.update_github(get_ghtoken()))
-        if RepoHost.OSF in mode:
+        if RepoHost.OSF in hosts:
             reports.extend(record.update_osf())
-        if RepoHost.GIN in mode:
+        if RepoHost.GIN in hosts:
             reports.extend(record.update_gin(os.environ["GIN_TOKEN"]))
-        if RepoHost.HUB_DATALAD_ORG in mode:
+        if RepoHost.HUB_DATALAD_ORG in hosts:
             reports.extend(
                 record.update_hub_datalad_org(os.environ["HUB_DATALAD_ORG_TOKEN"])
             )
-        if RepoHost.ATRIS in mode:
+        if RepoHost.ATRIS in hosts:
             reports.extend(record.update_atris())
         with open(RECORD_FILE, "w") as fp:
             print(record.model_dump_json(indent=4), file=fp)