Pympress package

This page contains the inline documentation, generated from the code using sphinx.

The code is documented in the source using the Google style for docstrings. Sphinx has gathered a set of examples which serves as a better crash course than the full style reference.

Retructured text (rst) can be used inside the comments and docstrings.

Modules

pympress.util – various utility functions

pympress.util.fileopen(f)[source]

Call the right function to open files, based on the platform.

Parameters

f (path-like) – path to the file to open

pympress.util.get_default_config()[source]

Returns the path to the configuration file containing the defaults.

Returns

The path to the portable configuration file.

Return type

Path

pympress.util.get_icon_path(name)[source]

Get the path for an image from pympress’ resources

Parameters

name (str) – The name of the icon to load

Returns

The path to the icon to load

Return type

str

pympress.util.get_locale_dir()[source]

Returns the path to the locale directory.

Returns

The path to the locale directory

Return type

Path

pympress.util.get_log_path()[source]

Returns the appropriate path to the log file in the user app dirs.

Returns

path to the log file.

Return type

Path

pympress.util.get_portable_config()[source]

Returns the path to the configuration file for a portable install (i.e. in the install root).

Returns

The path to the portable configuration file.

Return type

Path

pympress.util.get_pympress_meta()[source]

Get metadata (version, etc) from pympress’ __init__.py or git describe.

Returns

metadata properties (version, contributors) mapped to their values

Return type

dict

pympress.util.get_ui_resource_file(name, ext='.glade')[source]

Load an UI definition file from pympress’ resources

Parameters

  • name (str) – The name of the UI to load

  • ext (str) – The extension of the file

Returns

The full path to the glade file

Return type

str

pympress.util.get_user_config()[source]

Returns the path to the configuration file in the user config directory

Returns

path to the user configuration file.

Return type

Path

pympress.util.hard_set_screensaver(disabled)[source]

Enable or disable the screensaver.

Parameters

disabled (bool) – if True, indicates that the screensaver must be disabled; otherwise it will be enabled

pympress.util.list_icons()[source]

List the icons from pympress’ resources.

Returns

The paths to the icons in the pixmaps directory

Return type

list of str

pympress.util.load_style_provider(style_provider)[source]

Load the css and in a style provider

Parameters

style_provider (CssProvider) – The style provider in which to load CSS

Returns

The style provider with CSS loaded

Return type

CssProvider