Skip to content

Reworked main entry point #567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
randompersona1 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Reworked main entry point #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c12f1f4
Introduce GUI application, main entry point with CLI argument parsing…
randompersona1 Mar 10, 2026
eee465a
Merge branch 'main' into entrypoint
randompersona1 Mar 13, 2026
12a4509
Move entrypoint back to gui module
randompersona1 Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ dependencies = [
Repository = "https://github.com/bohning/usdb_syncer"

[project.scripts]
usdb_syncer = "usdb_syncer.gui:main"
usdb_syncer = "usdb_syncer.gui.main:main"

[build-system]
requires = ["hatchling", "hatch-vcs"]
Expand Down
279 changes: 5 additions & 274 deletions src/usdb_syncer/gui/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,17 @@

from __future__ import annotations

import contextlib
import io
import logging
import shutil
import subprocess
import sys
import time
import traceback
from argparse import ArgumentParser
from importlib import resources as importlib_resources
from pathlib import Path
from typing import TYPE_CHECKING, Any

import attrs
from PySide6 import QtCore, QtGui, QtWidgets
from PySide6.QtCore import Qt, qInstallMessageHandler
from PySide6.QtCore import Qt

import usdb_syncer
from usdb_syncer import (
addons,
constants,
data,
db,
Expand All @@ -35,11 +26,9 @@
from usdb_syncer import usdb_song as usdb_song
from usdb_syncer.gui import events, hooks, progress, theme
from usdb_syncer.gui.fonts import get_version_font
from usdb_syncer.webserver import webserver

if TYPE_CHECKING:
from collections.abc import Callable
from types import TracebackType
from pathlib import Path

# only import from gui after pyside file generation
from usdb_syncer.gui.mw import MainWindow
Expand All @@ -50,170 +39,9 @@
f" more recent release, or remove the file at '{utils.AppPaths.db}' and restart to "
"create a new database."
)
NOGIL_ERROR_MESSAGE = (
"USDB Syncer does not support running without the GIL. "
"Please use a build of Python with GIL support enabled."
)


@attrs.define
class CliArgs:
"""Command line arguments."""

log_level: str = "INFO"

reset_settings: bool = False
subcommand: str = ""

# Settings
songpath: Path | None = None

# Development
profile: bool = False
skip_pyside: bool = not constants.IS_SOURCE
trace_sql: bool = False
healthcheck: bool = False

# preview
txt: Path | None = None

# webserver
host: str | None = None
port: int | None = None
title: str | None = None
show_nonlocal: bool = False

@classmethod
def parse(cls) -> CliArgs:
parser = ArgumentParser(description="USDB Syncer")
parser.add_argument(
"--version", action="version", version=usdb_syncer.__version__
)
parser.add_argument(
"--log-level",
type=str.upper,
choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
help="Set the log level for stderr logging. Default is info.",
)
parser.add_argument(
"--reset-settings",
action="store_true",
help="Reset all settings to default.",
)

setting_overrides = parser.add_argument_group(
"settings", "Provide temporary overrides for settings."
)
setting_overrides.add_argument(
"--songpath", type=Path, help="path to the song folder"
)

dev_options = parser.add_argument_group("development", "Development options.")
dev_options.add_argument(
"--trace-sql", action="store_true", help="Trace SQL statements."
)
dev_options.add_argument(
"--profile", action="store_true", help="Run with profiling."
)
dev_options.add_argument(
"--healthcheck", action="store_true", help="Run healthcheck and exit."
)
if constants.IS_SOURCE:
dev_options.add_argument(
"--skip-pyside",
action="store_true",
help="Skip PySide file generation.",
)

subcommands = parser.add_subparsers(
title="subcommands", description="Subcommands.", dest="subcommand"
)
preview = subcommands.add_parser("preview", help="Show preview for song txt.")
preview.add_argument("txt", type=Path, help="Path to the song txt file.")

serve = subcommands.add_parser(
"serve", help="Launch webserver with local songs."
)
serve.add_argument(
"--host",
type=int,
help="Host for the webservice. Default is the device's public IP address. "
"Use 127.0.0.1 (localhost) to not be accessible by other devices "
"on the local network.",
)
serve.add_argument(
"--port",
type=int,
help="Port the webservice will bind to. Defaults to a random free port.",
)
serve.add_argument("--title", help="Title displayed at the top of the page.")
serve.add_argument(
"--show-nonlocal",
action="store_true",
help="Show songs that are not in the local collection.",
)

return parser.parse_args(namespace=cls())

def apply(self) -> None:
if self.healthcheck:
sys.exit(_run_healthcheck())
if self.reset_settings:
settings.reset()
if self.songpath:
settings.set_song_dir(self.songpath.resolve(), temp=True)
if constants.IS_SOURCE and not self.skip_pyside:
import tools.generate_pyside_files # pylint: disable=import-outside-toplevel

tools.generate_pyside_files.main()
db.set_trace_sql(self.trace_sql)


def main() -> None:
sys.excepthook = _excepthook
if not getattr(sys, "_is_gil_enabled", lambda: True)():
print(NOGIL_ERROR_MESSAGE)
sys.exit(1)
qInstallMessageHandler(handle_qt_log)
args = CliArgs.parse()
args.apply()
addons.load_all()
utils.AppPaths.make_dirs()
configure_logging(stderr_level=args.log_level)
app = _init_app()
app.setAttribute(Qt.ApplicationAttribute.AA_DontShowIconsInMenus, False)

def run_main() -> None:
QtCore.QTimer.singleShot(0, _run_main)
app.exec()

match args.subcommand:
case "preview":
if args.txt and _run_preview(args.txt):
app.exec()
case "serve":
_run_webserver(
host=args.host,
port=args.port,
title=args.title,
show_nonlocal_songs=args.show_nonlocal,
)
case _:
if args.profile:
_with_profile(run_main)
else:
run_main()


def configure_logging(stderr_level: logger.LOGLEVEL = logging.DEBUG) -> None:
handlers: list[logging.Handler] = [
logging.FileHandler(utils.AppPaths.log, encoding="utf-8"),
logger.StderrHandler(level=stderr_level),
]
logger.configure_logging(*handlers, formatter=logger.DEBUG_FORMATTER)


def _run_main() -> None:
def run_gui() -> None:
from usdb_syncer.gui.mw import MainWindow

mw = MainWindow()
Expand All @@ -239,49 +67,13 @@ def _run_main() -> None:
hooks.MainWindowDidLoad.call(mw)


def _run_preview(txt: Path) -> bool:
def run_preview(txt: Path) -> bool:
from usdb_syncer.gui.previewer import Previewer

theme.Theme.from_settings().apply()
return Previewer.load_txt(txt)


def _run_webserver(
host: str | None = None,
port: int | None = None,
title: str | None = None,
show_nonlocal_songs: bool = False,
) -> None:
webserver.start(
host=host, port=port, title=title, show_nonlocal_songs=show_nonlocal_songs
)
logger.logger.info("Webserver is running in headless mode. Press Ctrl+C to stop.")
try:
while True:
time.sleep(1)
except KeyboardInterrupt:
webserver.stop()


def _excepthook(
error_type: type[BaseException], error: BaseException, tb_type: TracebackType | None
) -> Any:
text = " ".join(traceback.format_exception(error_type, error, tb_type)).strip()
logger.logger.error(f"Uncaught exception:\n {text}")


def _with_profile(func: Callable[[], None]) -> None:
import cProfile

logger.logger.debug("Running with profiling enabled.")
profiler = cProfile.Profile()
profiler.enable()
func()
profiler.disable()
profiler.dump_stats(utils.AppPaths.profile)
subprocess.call(["snakeviz", utils.AppPaths.profile])


def _load_main_window(mw: MainWindow) -> None:
splash = SplashScreen()
splash.show()
Expand Down Expand Up @@ -345,7 +137,7 @@ def finish(self, w: QtWidgets.QWidget) -> None:
self.deleteLater()


def _init_app() -> QtWidgets.QApplication:
def init_app() -> QtWidgets.QApplication:
app = QtWidgets.QApplication(sys.argv)
app.setOrganizationName("bohning")
app.setApplicationName("usdb_syncer")
Expand Down Expand Up @@ -381,63 +173,6 @@ def _maybe_copy_licenses() -> None:
)


class StderrHandler(io.StringIO):
"""Handler for stderr that also prints to the original stderr."""

def __init__(self) -> None:
super().__init__()
self._original_stderr = sys.stderr

def write(self, s: str) -> int:
self._original_stderr.write(s)
return super().write(s)

def flush(self) -> None:
self._original_stderr.flush()
super().flush()


def _run_healthcheck() -> int:
"""Run a healthcheck and return exit code."""
handler = StderrHandler()
try:
with contextlib.redirect_stderr(handler):
# import sounddevice properly
from usdb_syncer.gui import previewer # noqa: F401

# gui modules check
from usdb_syncer.gui.mw import MainWindow # noqa: F401

# database check
db.connect(":memory:")

# resources check
from usdb_syncer.gui.resources.text import NOTICE

NOTICE.read_text(encoding="utf-8")

from usdb_syncer.gui.pdf import _ensure_fonts_downloaded_and_registered

_ensure_fonts_downloaded_and_registered()

# sounddevice check
import sounddevice

sounddevice.query_devices()

except Exception as e: # noqa: BLE001
traceback.print_exc()
print(f"USDB Syncer healthcheck: failed: {e}")
return 1
handler.seek(0)
for line in handler:
if "[ERROR]" in line or "[WARNING]" in line or "[CRITICAL]" in line:
print(f"USDB Syncer healthcheck: failed with error log: {line}")
return 2
print("USDB Syncer healthcheck: No problems found.")
return 0


def handle_qt_log(mode: int, _: Any, message: str) -> None:
"""Log Qt messages to the main logger."""
logger.logger.debug(f"Qt log message with mode {mode}: {message}")
Expand All @@ -460,7 +195,3 @@ def __init__(self, mw: MainWindow) -> None:
def emit(self, record: logging.LogRecord) -> None:
message = self.format(record)
self.signals.message_level_time.emit(message, record.levelno, record.created)


if __name__ == "__main__":
main()
Loading
Loading