Move CLI parsing to its own python module

Having this parsing done in the `__init__.py` script leads to issues
down the line when one wants to import parts of the code without having
to parse the CLI arguments.

Doing so enables us to remove the `dev_scripts/dangerzone*` scripts,
which were forcing the project into the path and enabling dev mode.

- The dev mode is now handled by the use of a DANGERZONE_DEV=1 environment
variable; and
- The path changes were actually unnecessary when using poetry run,
  which already does that for us.

Author: almet

dangerzone/__init__.py

@@ -30,22 +30,5 @@
 except ImportError:
     pass
 
-if "DANGERZONE_MODE" in os.environ:
-    mode = os.environ["DANGERZONE_MODE"]
-else:
-    cli_names = [
-        "dangerzone-cli",
-        "dangerzone-cli.exe",
-        "dangerzone-image",
-        "dangerzone-image.exe",
-    ]
-    if basename in cli_names:
-        mode = "cli"
-    else:
-        mode = "gui"
-
-
-if mode == "cli":
-    from .cli import cli_main as main
-else:
-    from .gui import gui_main as main  # noqa: F401
+if os.environ.get("DANGERZONE_DEV", "0") == "1":
+    setattr(sys, "dangerzone_dev", True)

dangerzone/cli.py

@@ -75,7 +75,7 @@ def print_header(s: str) -> None:
 )
 @click.version_option(version=get_version(), message="%(version)s")
 @errors.handle_document_errors
-def cli_main(
+def run(
     output_filename: Optional[str],
     ocr_lang: Optional[str],
     filenames: Optional[List[str]],
@@ -175,7 +175,7 @@ def cli_main(
     sys.exit(0)
 
 
-args.override_parser_and_check_suspicious_options(cli_main)
+args.override_parser_and_check_suspicious_options(run)
 
 
 def setup_logging() -> None:

dangerzone/gui/__init__.py

@@ -1,14 +1,7 @@
 import enum
 import logging
-import os
-import platform
-import signal
 import sys
 import typing
-from typing import List, Optional
-
-import click
-import colorama
 
 # FIXME: See https://github.com/freedomofpress/dangerzone/issues/320 for more details.
 if typing.TYPE_CHECKING:
@@ -19,17 +12,7 @@
     except ImportError:
         from PySide2 import QtCore, QtGui, QtWidgets
 
-from .. import args, errors
-from ..document import Document
-from ..isolation_provider.container import Container
-from ..isolation_provider.dummy import Dummy
-from ..isolation_provider.qubes import Qubes, is_qubes_native_conversion
-from ..settings import Settings
-from ..updater import errors as updater_errors
-from ..updater import releases
-from ..util import get_resource_path, get_version
-from .logic import DangerzoneGui
-from .main_window import MainWindow
+from ..util import get_resource_path
 
 log = logging.getLogger(__name__)
 
@@ -119,82 +102,5 @@ def _handle_palette_change(self) -> None:
             self.color_scheme_changed.emit()
 
 
-@click.command()
-@click.option(
-    "--unsafe-dummy-conversion", "dummy_conversion", flag_value=True, hidden=True
-)
-@click.argument(
-    "filenames",
-    required=False,
-    nargs=-1,
-    type=click.UNPROCESSED,
-    callback=args.validate_input_filenames,
-)
-@click.version_option(version=get_version(), message="%(version)s")
-@errors.handle_document_errors
-def gui_main(dummy_conversion: bool, filenames: Optional[List[str]]) -> bool:
-    setup_logging()
-
-    if platform.system() == "Darwin":
-        # Required for macOS Big Sur: https://stackoverflow.com/a/64878899
-        os.environ["QT_MAC_WANTS_LAYER"] = "1"
-
-        # Make sure /usr/local/bin is in the path
-        os.environ["PATH"] = "/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin"
-
-        # Don't show ANSI colors from stdout output, to prevent terminal
-        # colors from breaking the macOS GUI app
-        colorama.deinit()
-
-    # Create the Qt app
-    app = Application()
-
-    # Common objects
-    if getattr(sys, "dangerzone_dev", False) and dummy_conversion:
-        dummy = Dummy()
-        dangerzone = DangerzoneGui(app, isolation_provider=dummy)
-    elif is_qubes_native_conversion():
-        qubes = Qubes()
-        dangerzone = DangerzoneGui(app, isolation_provider=qubes)
-    else:
-        container = Container()
-        dangerzone = DangerzoneGui(app, isolation_provider=container)
-
-    # Allow Ctrl-C to smoothly quit the program instead of throwing an exception
-    signal.signal(signal.SIGINT, signal.SIG_DFL)
-
-    def open_files(filenames: List[str] = []) -> None:
-        documents = [Document(filename) for filename in filenames]
-        window.conversion_widget.doc_selection_widget.documents_selected.emit(documents)
-
-    window = MainWindow(dangerzone)
-    settings = Settings()
-    updates_enabled = bool(settings.get("updater_check_all"))
-    window.toggle_updates_action.setChecked(updates_enabled)
-    window.startup_thread.start()
-
-    if filenames:
-        open_files(filenames)
-
-    # MacOS: Open a new window, if all windows are closed
-    def application_activated() -> None:
-        window.show()
-        window.adjustSize()
-
-    # If we get a file open event, open it
-    app.document_selected.connect(open_files)
-
-    # If the application is activated and all windows are closed, open a new one
-    app.application_activated.connect(application_activated)
-
-    # Launch the GUI
-    ret = app.exec_()
-
-    sys.exit(ret)
-
-
 def setup_logging() -> None:
     logging.basicConfig(level=logging.DEBUG, format="[%(levelname)s] %(message)s")
-
-
-args.override_parser_and_check_suspicious_options(gui_main)

dangerzone/gui/run.py

@@ -0,0 +1,96 @@
+import os
+import platform
+import signal
+import sys
+from typing import List, Optional
+
+import click
+import colorama
+
+from .. import args, errors
+from ..document import Document
+from ..isolation_provider.container import Container
+from ..isolation_provider.dummy import Dummy
+from ..isolation_provider.qubes import Qubes, is_qubes_native_conversion
+from ..settings import Settings
+from ..util import get_version
+from . import Application, setup_logging
+from .logic import DangerzoneGui
+from .main_window import MainWindow
+
+
+@click.command()
+@click.option(
+    "--unsafe-dummy-conversion", "dummy_conversion", flag_value=True, hidden=True
+)
+@click.argument(
+    "filenames",
+    required=False,
+    nargs=-1,
+    type=click.UNPROCESSED,
+    callback=args.validate_input_filenames,
+)
+@click.version_option(version=get_version(), message="%(version)s")
+@errors.handle_document_errors
+def run(dummy_conversion: bool, filenames: Optional[List[str]]) -> Optional[bool]:
+    setup_logging()
+
+    if platform.system() == "Darwin":
+        # Required for macOS Big Sur: https://stackoverflow.com/a/64878899
+        os.environ["QT_MAC_WANTS_LAYER"] = "1"
+
+        # Make sure /usr/local/bin is in the path
+        os.environ["PATH"] = "/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin"
+
+        # Don't show ANSI colors from stdout output, to prevent terminal
+        # colors from breaking the macOS GUI app
+        colorama.deinit()
+
+    # Create the Qt app
+    app = Application()
+
+    # Common objects
+    if getattr(sys, "dangerzone_dev", False) and dummy_conversion:
+        dummy = Dummy()
+        dangerzone = DangerzoneGui(app, isolation_provider=dummy)
+    elif is_qubes_native_conversion():
+        qubes = Qubes()
+        dangerzone = DangerzoneGui(app, isolation_provider=qubes)
+    else:
+        container = Container()
+        dangerzone = DangerzoneGui(app, isolation_provider=container)
+
+    # Allow Ctrl-C to smoothly quit the program instead of throwing an exception
+    signal.signal(signal.SIGINT, signal.SIG_DFL)
+
+    def open_files(filenames: List[str] = []) -> None:
+        documents = [Document(filename) for filename in filenames]
+        window.conversion_widget.doc_selection_widget.documents_selected.emit(documents)
+
+    window = MainWindow(dangerzone)
+    settings = Settings()
+    updates_enabled = bool(settings.get("updater_check_all"))
+    window.toggle_updates_action.setChecked(updates_enabled)
+    window.startup_thread.start()
+
+    if filenames:
+        open_files(filenames)
+
+    # MacOS: Open a new window, if all windows are closed
+    def application_activated() -> None:
+        window.show()
+        window.adjustSize()
+
+    # If we get a file open event, open it
+    app.document_selected.connect(open_files)
+
+    # If the application is activated and all windows are closed, open a new one
+    app.application_activated.connect(application_activated)
+
+    # Launch the GUI
+    ret = app.exec_()
+
+    sys.exit(ret)
+
+
+args.override_parser_and_check_suspicious_options(run)

dangerzone/updater/cli.py

@@ -43,7 +43,7 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
 
 @click.group(context_settings={"show_default": True})
 @click.option("--debug", is_flag=True)
-def main(debug: bool) -> None:
+def run(debug: bool) -> None:
     if debug:
         click.echo("Debug mode enabled")
         level = logging.DEBUG
@@ -52,7 +52,7 @@ def main(debug: bool) -> None:
     logging.basicConfig(level=level)
 
 
-@main.command()
+@run.command()
 @requires_container_runtime
 def upgrade() -> None:
     """Upgrade the sandbox to the latest version available.
@@ -77,7 +77,7 @@ def upgrade() -> None:
         raise click.Abort()
 
 
-@main.command()
+@run.command()
 @click.option(
     "--image",
     default=DEFAULT_IMAGE_NAME,
@@ -91,7 +91,7 @@ def store_signatures(image: str) -> None:
     click.echo(f"✅ Signatures have been verified and stored locally")
 
 
-@main.command()
+@run.command()
 @click.argument("archive_filename", type=click.Path(exists=True))
 @click.option(
     "--force",
@@ -119,7 +119,7 @@ def load_archive(archive_filename: Path, force: bool) -> None:
         raise click.Abort()
 
 
-@main.command()
+@run.command()
 @click.option(
     "--image",
     default=DEFAULT_IMAGE_NAME,
@@ -149,7 +149,7 @@ def prepare_archive(image: str, output: str, arch: str) -> None:
         raise click.Abort()
 
 
-@main.command()
+@run.command()
 @click.option(
     "--image",
     default=DEFAULT_IMAGE_NAME,
@@ -171,7 +171,7 @@ def verify_local(image: str) -> None:
         )
 
 
-@main.command()
+@run.command()
 @click.argument("image_name")
 @click.option(
     "--repository",
@@ -206,4 +206,4 @@ def attest_provenance(
 
 
 if __name__ == "__main__":
-    main()
+    run()