Don't expose the list_resolution_strategies option to the apps. nit: End all click option help strings with a dot for consistency

Author: bergercookie

syncall/cli.py

@@ -35,7 +35,7 @@ def _opt_pdb_on_error():
         "--pdb-on-error",
         "pdb_on_error",
         is_flag=True,
-        help="Invoke PDB if there's an uncaught exception during the program execution",
+        help="Invoke PDB if there's an uncaught exception during the program execution.",
         callback=_set_own_excepthook,
         expose_value=True,
         is_eager=True,
@@ -163,7 +163,7 @@ def _opt_tw_filter():
         type=str,
         help=(
             "Taskwarrior filter for specifying the tasks to synchronize. These filters will be"
-            " concatenated using OR  with potential tags and projects potentially specified"
+            " concatenated using OR  with potential tags and projects potentially specified."
         ),
     )
 
@@ -174,7 +174,7 @@ def _opt_tw_all_tasks():
         "--taskwarrior-all-tasks",
         "tw_sync_all_tasks",
         is_flag=True,
-        help="Sync all taskwarrior tasks (potentially very slow)",
+        help="Sync all taskwarrior tasks (potentially very slow).",
     )
 
 
@@ -184,7 +184,7 @@ def _opt_tw_tags():
         "--taskwarrior-tags",
         "tw_tags",
         type=str,
-        help="Taskwarrior tags to synchronize",
+        help="Taskwarrior tags to synchronize.",
         expose_value=True,
         multiple=True,
     )
@@ -196,7 +196,7 @@ def _opt_tw_project():
         "--tw-project",
         "tw_project",
         type=str,
-        help="Taskwarrior project to synchronize",
+        help="Taskwarrior project to synchronize.",
         expose_value=True,
         is_eager=True,
     )
@@ -216,7 +216,7 @@ def callback(ctx, param, value):
         type=str,
         help=(
             "Only synchronize Taskwarrior tasks that have been modified in the last X days"
-            " (specify X, e.g., 1, 30, 0.5, etc.)"
+            " (specify X, e.g., 1, 30, 0.5, etc.)."
         ),
         callback=callback,
     )
@@ -229,7 +229,7 @@ def _opt_prefer_scheduled_date():
         is_flag=True,
         help=(
             'Prefer using the "scheduled" date field instead of the "due" date if the former'
-            " is available"
+            " is available."
         ),
     )
 
@@ -241,7 +241,7 @@ def opt_notion_page_id():
         "--notion-page",
         "notion_page_id",
         type=str,
-        help="Page ID of the Notion page to synchronize",
+        help="Page ID of the Notion page to synchronize.",
     )
 
 
@@ -250,7 +250,7 @@ def opt_notion_token_pass_path():
         "--token",
         "--token-pass-path",
         "token_pass_path",
-        help="Path in the UNIX password manager to fetch",
+        help="Path in the UNIX password manager to fetch.",
     )
 
 
@@ -279,7 +279,7 @@ def _opt_gkeep_user_pass_path():
         "--user",
         "--user-pass-path",
         "gkeep_user_pass_path",
-        help="Path in the UNIX password manager to fetch the Google username from",
+        help="Path in the UNIX password manager to fetch the Google username from.",
         default="gkeepapi/user",
     )
 
@@ -289,7 +289,7 @@ def _opt_gkeep_passwd_pass_path():
         "--passwd",
         "--passwd-pass-path",
         "gkeep_passwd_pass_path",
-        help="Path in the UNIX password manager to fetch the Google password from",
+        help="Path in the UNIX password manager to fetch the Google password from.",
         default="gkeepapi/passwd",
     )
 
@@ -299,7 +299,7 @@ def _opt_gkeep_token_pass_path():
         "--token",
         "--token-pass-path",
         "gkeep_token_pass_path",
-        help="Path in the UNIX password manager to fetch the google keep token from",
+        help="Path in the UNIX password manager to fetch the google keep token from.",
         default="gkeepapi/token",
     )
 
@@ -310,7 +310,7 @@ def _opt_gkeep_labels():
         "--gkeep-labels",
         type=str,
         multiple=True,
-        help="Google Keep labels whose notes to synchronize",
+        help="Google Keep labels whose notes to synchronize.",
     )
 
 
@@ -320,7 +320,7 @@ def _opt_gkeep_ignore_labels():
         "--gkeep-ignore-labels",
         type=str,
         multiple=True,
-        help="Google Keep labels whose notes will be explicitly ignored",
+        help="Google Keep labels whose notes will be explicitly ignored.",
     )
 
 
@@ -331,7 +331,7 @@ def _opt_gkeep_note():
         type=str,
         help=(
             "Full title of the Google Keep Note to synchronize - Make sure you enable the"
-            " checkboxes"
+            " checkboxes."
         ),
     )
 
@@ -342,7 +342,7 @@ def opt_gcal_calendar():
         "-c",
         "--gcal-calendar",
         type=str,
-        help="Name of the Google Calendar to synchronize (will be created if not there)",
+        help="Name of the Google Calendar to synchronize (will be created if not there).",
     )
 
 
@@ -352,7 +352,7 @@ def opt_gtasks_list():
         "-l",
         "--gtasks-list",
         type=str,
-        help="Name of the Google Tasks list to synchronize (will be created if not there)",
+        help="Name of the Google Tasks list to synchronize (will be created if not there).",
     )
 
 
@@ -362,7 +362,7 @@ def opt_google_secret_override():
         "--google-secret",
         default=None,
         type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True),
-        help="Override the client secret used for the communication with the Google APIs",
+        help="Override the client secret used for the communication with the Google APIs.",
     )
 
 
@@ -371,7 +371,7 @@ def opt_google_oauth_port():
         "--oauth-port",
         default=8081,
         type=int,
-        help="Port to use for OAuth Authentication with Google Applications",
+        help="Port to use for OAuth Authentication with Google Applications.",
     )
 
 
@@ -399,15 +399,15 @@ def _opt_caldav_calendar():
         "--caldav-calendar",
         type=str,
         default="Personal",
-        help="Name of the caldav Calendar to sync (will be created if not there)",
+        help="Name of the caldav Calendar to sync (will be created if not there).",
     )
 
 
 def _opt_caldav_url():
     return click.option(
         "--caldav-url",
         type=str,
-        help="URL where the caldav calendar is hosted at (including /dav if applicable)",
+        help="URL where the caldav calendar is hosted at (including /dav if applicable).",
     )
 
 
@@ -424,15 +424,15 @@ def _opt_caldav_passwd_pass_path():
         "--caldav-passwd",
         "--caldav-passwd-pass-path",
         "caldav_passwd_pass_path",
-        help="Path in the UNIX password manager to fetch the caldav password from",
+        help="Path in the UNIX password manager to fetch the caldav password from.",
     )
 
 
 def _opt_caldav_passwd_cmd():
     return click.option(
         "--caldav-passwd-cmd",
         "caldav_passwd_cmd",
-        help="Command that outputs the caldav password on stdout",
+        help="Command that outputs the caldav password on stdout.",
     )
 
 
@@ -444,7 +444,7 @@ def opt_filesystem_root():
         "filesystem_root",
         required=False,
         type=str,
-        help="Directory to consider as root for synchronization operations",
+        help="Directory to consider as root for synchronization operations.",
     )
 
 
@@ -454,7 +454,7 @@ def opt_filename_extension():
         "--filename-extension",
         "filename_extension",
         type=str,
-        help="Use this extension for locally created files",
+        help="Use this extension for locally created files.",
         default=".md",
     )
 
@@ -492,15 +492,12 @@ def opt_default_duration_event_mins():
         "default_event_duration_mins",
         default=30,
         type=int,
-        help="The default duration of an event that is to be created [in minutes]",
+        help="The default duration of an event that is to be created [in minutes].",
     )
 
 
 def _list_named_combinations(config_fname: str) -> None:
-    """List the named configurations currently available for the given configuration name.
-
-    Mainly used by the top-level synchronization apps.
-    """
+    """List the named configurations currently available for the given configuration name."""
     logger.success(
         format_list(
             header="\n\nNamed configurations currently available",
@@ -511,19 +508,20 @@ def _list_named_combinations(config_fname: str) -> None:
 
 def _opt_list_combinations(side_A_name: str, side_B_name: str):
     def callback(ctx, param, value):
-        _list_named_combinations(
-            config_fname=determine_app_config_fname(
-                side_A_name=side_A_name, side_B_name=side_B_name
+        if value is True:
+            _list_named_combinations(
+                config_fname=determine_app_config_fname(
+                    side_A_name=side_A_name, side_B_name=side_B_name
+                )
             )
-        )
-        sys.exit(0)
+            sys.exit(0)
 
     return click.option(
         "--list-combinations",
         "do_list_combinations",
         is_flag=True,
         expose_value=False,
-        help=f"List the available named {side_A_name}<->{side_B_name} combinations",
+        help=f"List the available named {side_A_name}<->{side_B_name} combinations.",
         callback=callback,
     )
 
@@ -534,25 +532,25 @@ def _opt_resolution_strategy():
         "--resolution-strategy",
         default="AlwaysSecondRS",
         type=click.Choice(list(name_to_resolution_strategy_type.keys())),
-        help="Resolution strategy to use during conflicts",
+        help="Resolution strategy to use during conflicts.",
     )
 
 
-def _list_resolution_strategies(ctx, param, value):
-    if value is not True:
-        return
-
-    strs = name_to_resolution_strategy_type.keys()
-    click.echo("\n".join([f"{a}. {b}" for a, b in zip(range(1, len(strs) + 1), strs)]))
-    sys.exit(0)
+def _opt_list_resolution_strategies():
+    def _list_resolution_strategies(ctx, param, value):
+        if value is not True:
+            return
 
+        strs = name_to_resolution_strategy_type.keys()
+        click.echo("\n".join([f"{a}. {b}" for a, b in zip(range(1, len(strs) + 1), strs)]))
+        sys.exit(0)
 
-def _opt_list_resolution_strategies():
     return click.option(
         "--list-resolution-strategies",
         callback=_list_resolution_strategies,
         is_flag=True,
-        help="List all the available resolution strategies and exit",
+        expose_value=False,
+        help="List all the available resolution strategies and exit.",
     )
 
 
@@ -562,7 +560,7 @@ def _opt_combination(side_A_name: str, side_B_name: str):
         COMBINATION_FLAGS[1],
         "combination_name",
         type=str,
-        help=f"Name of an already saved {side_A_name}<->{side_B_name} combination",
+        help=f"Name of an already saved {side_A_name}<->{side_B_name} combination.",
     )
 
 

syncall/scripts/fs_gkeep_sync.py

@@ -56,7 +56,6 @@ def main(
     verbose: int,
     combination_name: str,
     custom_combination_savename: str,
-    list_resolution_strategies: bool,
     pdb_on_error: bool,
 ):
     """

syncall/scripts/tw_asana_sync.py

@@ -55,7 +55,6 @@ def main(
     verbose: int,
     combination_name: str,
     custom_combination_savename: str,
-    list_resolution_strategies: bool,
     pdb_on_error: bool,
 ):
     """Synchronize your tasks in Asana with filters from Taskwarrior."""

syncall/scripts/tw_caldav_sync.py

@@ -54,7 +54,6 @@ def main(
     verbose: int,
     combination_name: str,
     custom_combination_savename: str,
-    list_resolution_strategies: bool,
     pdb_on_error: bool,
 ):
     """Synchronize lists of tasks from your caldav Calendar with filters from Taskwarrior.

syncall/scripts/tw_gcal_sync.py

@@ -59,7 +59,6 @@ def main(
     verbose: int,
     combination_name: str,
     custom_combination_savename: str,
-    list_resolution_strategies: bool,  # type: ignore
     default_event_duration_mins: int,
     pdb_on_error: bool,
 ):

syncall/scripts/tw_gkeep_sync.py

@@ -51,7 +51,6 @@ def main(
     verbose: int,
     combination_name: str,
     custom_combination_savename: str,
-    list_resolution_strategies: bool,
     pdb_on_error: bool,
 ):
     """Synchronize Notes from your Google Keep with filters from Taskwarrior.

syncall/scripts/tw_gtasks_sync.py

@@ -56,7 +56,6 @@ def main(
     verbose: int,
     combination_name: str,
     custom_combination_savename: str,
-    list_resolution_strategies: bool,
     pdb_on_error: bool,
 ):
     """Synchronize lists from your Google Tasks with filters from Taskwarrior.

syncall/scripts/tw_notion_sync.py

@@ -59,7 +59,6 @@ def main(
     verbose: int,
     combination_name: str,
     custom_combination_savename: str,
-    list_resolution_strategies: bool,
     pdb_on_error: bool,
 ):
     """Synchronise filters of TW tasks with the to_do items of Notion pages.