config

config

version: v1.0.1

A module for setting up constants for the package.

function stubs_dir() [src]

def stubs_dir() -> None | str

Returns the currently set external directory for stub files or None if no such directory was set.

function set_stubs_dir() [src]

def set_stubs_dir(new_path: str | None = None) -> None

Sets the path to an external directory for stub files.

Using an external directory allows easier manual editing/inspection of stub files (for tab-completion) and it removes the stub files from the package directory. The project-local directory should be marked as Sources Root and stub files should have identical paths as they would in the package directory. Set None to use the package directory. When using a project-local directory, the stub files should be created by calling write_stub() of the module.

Parameters:

• new_path: The path to the external directory to write stub files to. The default is None.

function theme_dir() [src]

def theme_dir() -> str

Returns the currently set path to the directory containing themes.

function set_theme_dir() [src]

def set_theme_dir(new_path: str) -> None

Sets a path to the theme directory enabling the use of the theme module and other reliant modules.

Parameters:

• new_path: The path to the directory containing themes.

function cfd_data_file_path() [src]

def cfd_data_file_path() -> str

Returns the currently set path to the file containing the custom file dialog data.

function set_cfd_data_file_path() [src]

def set_cfd_data_file_path(new_path: str) -> None

Sets a new path for the custom file dialog data file.

Parameters:

• new_path: The new path to set.

funtion mbt_file_path() [src]

def mbt_file_path() -> str

Returns the currently set path to the file containing the messagebox types.

function set_mbt_file_path() [src]

def set_mbt_file_path(new_path: str) -> None

Sets a new path for the messagebox types file.

Parameters:

• new_path: The new path to set.

funtion use_theme() [src]

def use_theme() -> bool

Returns the enabled state of the theme package.

function set_use_theme() [src]

def set_use_theme(use: bool = True) -> None

Enables/disables the use of the theme package.

Parameters:

• use: The new state to set. The default is True.

function icon_file_path() [src]

def icon_file_path() -> str

Returns the path for the icon file to be used in the dialogs.

function set_icon_file_path() [src]

def set_icon_file_path(new_path: str = '') -> None

Sets the path for the icon file to be used in the dialogs.

Parameters:

• new_path: The new path to set for the windows. The default is an empty string, leading to the default icon.