neurotorchmz.core.settings

Provides a module to load and update settings. Provides also the paths of resources and the temp folder for other modules

Functions

clear_temp_files()

Clears the temporary files and folders

Classes

BoolOption(default_value)
Config()
FloatOption(default_value)
IntOption(default_value)
Option(default_value)
PathOption(default_value)
Section()
StringOption(default_value)
UserSettings()

class neurotorchmz.core.settings.BoolOption(default_value)

Bases: Option

get() → bool

class neurotorchmz.core.settings.Config

Bases: object

config_parser: ConfigParser

config_path: Path

classmethod load_config()

Initializes the config parser

classmethod save_config() → None

class neurotorchmz.core.settings.FloatOption(default_value)

Bases: Option

get() → float

class neurotorchmz.core.settings.IntOption(default_value)

Bases: Option

get() → int

class neurotorchmz.core.settings.Option(default_value)

Bases: object

property config_parser: ConfigParser

get()

name: str

save() → None

section: type[Section]

set(val: Any, save: bool = False) → None

class neurotorchmz.core.settings.PathOption(default_value)

Bases: Option

get() → Path | None

class neurotorchmz.core.settings.Section

Bases: object

config: type[Config]

class neurotorchmz.core.settings.StringOption(default_value)

Bases: Option

get() → str

class neurotorchmz.core.settings.UserSettings

Bases: Config

class IMAGEJ

Bases: Section

config

alias of UserSettings

imagej_path = <neurotorchmz.core.settings.PathOption object>

class SIGNAL_DETECTION

Bases: Section

config

alias of UserSettings

peak_width_left = <neurotorchmz.core.settings.IntOption object>

peak_width_right = <neurotorchmz.core.settings.IntOption object>

config_parser: ConfigParser = <configparser.ConfigParser object>

config_path: Path = PosixPath('/home/runner/.local/share/NeurotorchMZ/settings.ini')

neurotorchmz.core.settings.clear_temp_files()

Clears the temporary files and folders