app package

Module contents

class app.ConfigManager

Bases : object

Manages configuration state for the UI application.

get_effective_config_path()

Get the effective config path, falling back to default if needed.

Type renvoyé:

Path

toggle_vessel_mode()

Toggle vessel mode and handle mutual exclusivity. Returns True if changed.

Type renvoyé:

bool

toggle_waterline_mode()

Toggle waterline mode and handle mutual exclusivity. Returns True if changed.

Type renvoyé:

bool

update_config_path(path_str)

Update config path from string input.

Type renvoyé:

None

update_output_path(path_str)

Update output path from string input.

Type renvoyé:

None

class app.DependencyContainer

Bases : object

Conteneur pour l’injection de dépendance.

get_config_manager()

Type renvoyé:

ConfigManager

get_file_display()

Type renvoyé:

FileDisplay

get_file_manager()

Type renvoyé:

FileManager

get_file_operations()

Type renvoyé:

FileOperations

get_file_selection_component()

Type renvoyé:

FileSelectionComponentNative

get_log_display()

Type renvoyé:

LogDisplay

get_log_handler()

Type renvoyé:

UILogHandler

get_status_display()

Type renvoyé:

StatusDisplay

get_theme_manager()

Type renvoyé:

ThemeManager

get_ui_event_handler()

Type renvoyé:

UIEventHandler

get_validator()

Type renvoyé:

Validator

class app.FileDisplay(get_files_callback, remove_callback=None)

Bases : object

Component for displaying selected files.

static _format_file_size(size_bytes)

Format file size in human readable format.

Type renvoyé:

str

_create_file_card(file_info)

Create a card for a single file.

Type renvoyé:

None

_handle_remove(file_info)

Handle file removal and update display.

Type renvoyé:

None

create()

Create the file display component.

Type renvoyé:

Column

update()

Update the file display.

Type renvoyé:

None

class app.FileManager

Bases : object

Handles file operations for the application.

static _is_numeric_extension(extension)

Check if the extension is numeric (e.g., .1, .2, .3).

Type renvoyé:

bool

async static open_config_dialog(initial_dir='')

Open config file selection dialog and return selected file.

Type renvoyé:

str

async static open_directory_dialog(initial_dir='')

Open directory selection dialog and return selected directory.

Type renvoyé:

str

_is_duplicate(file_name)

Check if file name already exists in collection.

Type renvoyé:

bool

add_files(file_paths)

Add files to the collection and return number of added files.

Type renvoyé:

int

clear_files()

Clear all files from the collection.

get_file_paths()

Get file paths for processing.

Type renvoyé:

list[Path]

get_files()

Get all files in the collection.

Type renvoyé:

list[dict[str, Any]]

remove_file(file_info)

Remove a file from the collection.

Type renvoyé:

bool

ALLOWED_EXTENSIONS = {'.csv', '.geojson', '.txt', '.xyz'}

class app.FileOperations(config_manager, file_manager, validator)

Bases : object

Handles file-related operations like dialogs and file management.

get_files()

Get files from file manager - delegation method.

remove_file(file_info)

Remove a file from the upload list.

Type renvoyé:

bool

async select_config_file()

Open config file selection dialog.

Type renvoyé:

str | None

async select_output_directory(output_warning_label=None)

Open directory selection dialog.

Type renvoyé:

str | None

class app.FileSelectionComponentNative(file_manager, validator, file_display)

Bases : FileSelectionComponentABC

Component for file selection in the native application.

_add_selected_files(file_paths)

Add selected files from dialog.

_clear_files()

Clear all selected files.

async _open_file_dialog()

Open file selection dialog using native method.

create()

Create the file selection section.

class app.FileSelectionComponentWeb(file_manager, validator, file_display)

Bases : FileSelectionComponentABC

Component for file selection in the web application.

static _handle_rejected(event)

Handle rejected file uploads.

static _save_uploaded_file(file_info)

Save uploaded file content and return file path.

Type renvoyé:

Generator[Path, None, None]

_add_uploaded_files(file_paths)

Add uploaded files to file manager.

_clear_files()

Clear all selected files.

_handle_upload(event)

Handle file upload event.

create()

Create the file selection section.

Type renvoyé:

None

class app.GuiType(value)

Bases : StrEnum

Enumeration for GUI types.

NATIVE = 'native'

WEB = 'web'

class app.HeaderComponent(theme_manager)

Bases : object

Component for application header.

create()

Create the header section.

class app.LogDisplay(log_handler)

Bases : object

Component for displaying log output.

static _get_log_color(log_message)

Get color class based on log level.

Type renvoyé:

str

clear_logs()

Clear all logs.

Type renvoyé:

None

create()

Create the log display component.

Type renvoyé:

Column

hide()

Hide the log display if it’s visible.

Type renvoyé:

None

show()

Show the log display if it’s hidden.

Type renvoyé:

None

toggle_visibility()

Toggle log visibility.

Type renvoyé:

None

update_logs()

Update log display with new log entries.

Type renvoyé:

None

class app.LogSection(log_display)

Bases : object

Component for the log section.

create()

Create log output section.

class app.OptionsComponent(config_path, config_manager, ui_event_handler)

Bases : object

Component for processing options.

_create_left_column()

Create left column of options.

_create_right_column()

Create right column of options.

_handle_config_path_change(e)

Handle config path change.

_handle_output_path_change(e)

Handle output path change.

async _handle_select_config_file()

Handle config file selection.

Type renvoyé:

None

async _handle_select_output_directory()

Handle output directory selection.

_handle_vessel_toggle()

Handle vessel option toggle.

_handle_waterline_toggle()

Handle waterline option toggle.

create()

Create the options section.

class app.ProcessingHandler(config_manager, file_manager, validator, status_display, log_display, log_settings=None)

Bases : object

Handles the file processing workflow.

async _execute_processing_workflow()

Execute the main processing workflow.

Type renvoyé:

None

async _handle_error(error)

Handle processing errors.

Type renvoyé:

None

async _handle_success()

Handle successful processing completion.

Type renvoyé:

None

async _handle_validation_errors(validation_errors)

Handle validation errors.

Type renvoyé:

None

_perform_validation()

Perform comprehensive validation and return list of errors.

Type renvoyé:

list[str]

_prepare_vessel_config()

Prepare vessel configuration based on current settings.

Type renvoyé:

Any

async _run_processing_workflow(valid_files, vessel_config, output, config)

Run the processing workflow in a separate thread.

Type renvoyé:

None

async process_files()

Process the uploaded files.

Type renvoyé:

None

class app.ProcessingSection(process_callback)

Bases : object

Component for the processing section.

async _on_click(*args)

Wrapper that disables the button, runs the callback, then re-enables the button.

create()

Create processing section.

class app.StatusDisplay

Bases : object

Component for displaying processing status.

create()

Create the status display component.

Type renvoyé:

Label

set_status(text, status_type='info')

Set the status with appropriate styling.

Type renvoyé:

None

class app.StatusSection(status_display)

Bases : object

Component for the status section.

create()

Create status section.

class app.ThemeManager(dark_mode=True)

Bases : object

Gestionnaire des thèmes de l’interface utilisateur.

static add_theme_styles()

Ajoute les styles CSS personnalisés pour les thèmes.

Type renvoyé:

None

create_theme_button()

Crée le bouton de basculement de thème.

Type renvoyé:

Button

toggle_theme()

Bascule entre le thème clair et sombre.

Type renvoyé:

None

class app.UIEventHandler(config_manager, file_operations, validator, log_display)

Bases : object

remove_file(file_info, file_selection_component)

Remove a file from the upload list.

Type renvoyé:

None

async select_config_file()

Select config file and return the selected path.

Type renvoyé:

str

async select_output_directory()

Select output directory and return the selected path.

Type renvoyé:

str

toggle_vessel()

Toggle vessel option and return True if waterline was disabled.

Type renvoyé:

bool

toggle_waterline()

Toggle waterline option and return True if vessel was disabled.

Type renvoyé:

bool

update_config_path(path)

Update config_path when input changes.

Type renvoyé:

None

update_output_path(path)

Update output_path when input changes.

Type renvoyé:

None

class app.UILogHandler(level='INFO')

Bases : object

Custom log handler to capture logs for UI display.

clear_logs()

Clear all logs from the queue.

Type renvoyé:

None

get_log_settings()

Get log configuration for external loggers.

Type renvoyé:

dict

get_logs()

Get all available logs from queue.

Type renvoyé:

list[str]

setup_logger()

Setup custom log handler for UI display.

Type renvoyé:

None

write(message)

Write log message to queue.

Type renvoyé:

None

FORMAT: str = '{time:YYYY-MM-DD HH:mm:ss} | {level:^8} | {message}'

class app.UIRunner(main_ui, gui)

Bases : object

Runner for the CSB Processing UI application.

static _find_available_port()

Find an available port for the application.

run()

Run the CSB Processing UI application.

Type renvoyé:

None

class app.Validator(get_files_func, config_manager)

Bases : object

validate_file_selection()

Check if at least one file is selected.

Type renvoyé:

bool

validate_inputs()

Validate all inputs and return list of errors.

Type renvoyé:

list[str]

validate_mutual_exclusivity()

Check vessel and waterline options mutual exclusivity.

Type renvoyé:

bool

validate_output_path()

Check if output path is specified.

Type renvoyé:

bool

validate_vessel_configuration()

Check vessel configuration validity.

Type renvoyé:

bool

validate_waterline_configuration()

Check waterline configuration validity.

Type renvoyé:

bool