wolfhece.PyConfig

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

wolfhece.PyConfig._default_plugins_directory() → pathlib.Path

Return the built-in plugins directory and make sure it exists.

class wolfhece.PyConfig.ConfigurationKeys(*args, **kwds)

Bases: enum.Enum

Using enumerated keys make sure we can check value names at code write time (i.e. we don’t use string which are brittle)

VERSION = 'Version'

PLAY_WELCOME_SOUND = 'PlayWelcomeSound'

TICKS_SIZE = 'TicksSize'

TICKS_BOUNDS = 'TicksBounds'

TICKS_XROTATION = 'TicksXRotation'

TICKS_FONTSIZE = 'TicksFontSize'

OVERLAY_XY_FONT_NAME = 'OverlayXYFontName'

OVERLAY_XY_FONT_SIZE = 'OverlayXYFontSize'

TOOLBAR_TOOLTIP_FONT_SIZE = 'ToolbarTooltipFontSize'

COLOR_BACKGROUND = 'ColorBackground'

ACTIVE_ARRAY_PALETTE_FOR_IMAGE = 'Use active array palette for image'

ACTIVE_RES2D_PALETTE_FOR_IMAGE = 'Use active result palette for image'

ASSEMBLY_IMAGES = 'AssemblyImages'

DIRECTORY_DEM = 'Default DEM directory'

DIRECTORY_DTM = 'Default DTM directory'

DIRECTORY_LAZ = 'Default LAZ directory'

ACTIVE_VECTOR_COLOR = 'Active vector color'

ACTIVE_VECTOR_SIZE_SQUARE = 'Active vector square size'

XLSX_HECE_DATABASE = 'Hece Database XLSX file'

EPSG_CODE = 'Default EPSG code'

SNAP_GRID_UNIT = 'Snap grid base unit'

SNAP_GRID_ROUND_BASE = 'Snap grid origin round base'

OVERLAY_BG_COLOR = 'OverlayBgColor'

PLUGINS_DIRECTORY = 'PluginsDirectory'

PLUGINS_DISABLED = 'PluginsDisabled'

class wolfhece.PyConfig.WolfConfiguration(path=None)

Holds the PyWolf configuration

property path: pathlib.Path

Where the configuration is read/saved.

set_default_config()

_check_config()

load()

save()

class wolfhece.PyConfig.GlobalOptionsDialog(*args, **kw)

Bases: wx.Dialog

A dialog to set global options for a WolfMapViewer.

push_configuration(configuration)

pull_configuration(configuration)

InitUI()

_init_tab_general(notebook)

_init_tab_display(notebook)

_init_tab_directories(notebook)

_init_tab_vectors(notebook)

_init_tab_plugins(notebook)

Create the Plugins tab in the options notebook.

_populate_plugins_list(plugins_dir: str, disabled: list) → None

Refresh the plugins check-list (built-in first, then user plugins).

_collect_disabled_plugins() → list

Return the list of plugin names (strings) that are unchecked.

_OnPluginChecked(event) → None

Ask for approval when the user enables an unknown/changed external plugin.

_OnNewPlugin(event)

Open the ‘New plugin from template’ dialog and scaffold the files.

_OnChoosePluginsDir(event)

Browse for a custom plugins directory.

OnChooseDem(e)

Choose a directory for DEM files

OnChooseDtm(e)

Choose a directory for DTM files

OnChooseLaz(e)

Choose a directory for LAZ files

OnChooseXLSX(e)

Choose a XLSX file for HECE database

OnOk(e)

OnClose(e)

wolfhece.PyConfig._plugin_menu_badge(info) → str

Return '☰ ', '⚡ ', or '' based on whether info has a menu.

wolfhece.PyConfig._plugin_badges(info, trust_store) → str

Return a combined trust + menu badge prefix for info.

Format: '<trust> <menu> ' (e.g. '★ ☰ ', '✓ ⚡ ', '? ☰ ')

wolfhece.PyConfig._slug_to_class_name(slug: str) → str

Convert a slug like my_feature to a class name MyFeatureCompanion.

wolfhece.PyConfig._create_plugin_from_template(slug: str, display_name: str, author: str, description: str, target_dir) → pathlib.Path

Copy the template directory to target_dir/<slug> with substituted values.

Raises:

• FileExistsError – if the target directory already exists.

• FileNotFoundError – if the template directory is missing.

Returns:

Path to the created plugin directory.

class wolfhece.PyConfig._NewPluginDialog(parent, target_dir)

Bases: wx.Dialog

Small form to collect metadata for a new plugin.

_target_dir

property slug: str

property display_name: str

property author: str

property description: str

_build_ui()

_on_ok(event)

wolfhece.PyConfig.handle_configuration_dialog(wxparent, configuration)

wolfhece.PyConfig.cfg