Configuration

module: rspub.core.config

Save and load multiple configurations

The class Configurations (mark the s at the end) enables you to save, load, remove and list multiple configurations.

Class Configuration (mark the absence of s at the end) is a singleton. It should not be used directly. In stead use rspub.core.rs_paras.RsParameters.

The location where configurations are stored is system-dependent:

• {user-home}\AppData\Local\Programs\rspub\config\ on Windows
• {user-home}/.config/rspub/config/ on Mac and Linux
• {user-home}/rspub/config/ fallback

See also

RsParameters

class rspub.core.config.Configurations

Bases: object

Enables saving, loading, listing and removing configurations

All methods are static:

Configurations.list_configurations()
Configurations.load_configuration("collection_1")
# etc.

static list_configurations() → list

List available configurations

Returns:list of names of previously saved configurations

static load_configuration(name: str)

Load the configuration with the given name

Parameters:name – name of a previously saved configuration Returns:the restored Configuration

static save_configuration_as(name: str)

Save the current configuration under the given name

Any previously saved configurations with the same name will be overwritten without warning.

Parameters:name – name under which the configuration will be saved

static remove_configuration(name: str)

Remove the configuration with the given name

Parameters:name – the name of the configuration to remove Returns:True if the configuration was successfully removed, False otherwise

static current_configuration_name()

Get the name of the current configuration

Returns:name of the current configuration

static rspub_config_dir()

class rspub.core.config.Configuration

Bases: object

Singleton persisting object for storing configuration parameters

Warning

Do not use class Configuration directly. Use RsParameters in stead.

static reset()

config_path = '/home/docs/.config/rspub/core'

config_file = '/home/docs/.config/rspub/core/DEFAULT.cfg'

name()

persist()

core_items()

core_clear()

resource_dir(fallback='/home/docs')

set_resource_dir(resource_dir)

metadata_dir(fallback='metadata')

set_metadata_dir(metadata_dir)

description_dir(fallback=None)

set_description_dir(description_dir)

selector_file(fallback=None)

set_selector_file(selector_file)

simple_select_file(fallback=None)

set_simple_select_file(simple_file)

select_mode(fallback='simple')

set_select_mode(mode)

plugin_dir(fallback=None)

set_plugin_dir(plugin_dir)

history_dir(fallback=None)

set_history_dir(history_dir)

url_prefix(fallback='http://www.example.com')

set_url_prefix(urlprefix)

strategy(fallback='resourcelist')

set_strategy(strategy)

max_items_in_list(fallback=50000)

set_max_items_in_list(max_items)

zero_fill_filename(fallback=4)

set_zero_fill_filename(zfill)

is_saving_pretty_xml(fallback=True)

set_is_saving_pretty_xml(p_xml)

is_saving_sitemaps(fallback=True)

set_is_saving_sitemaps(is_saving)

has_wellknown_at_root(fallback=True)

set_has_wellknown_at_root(at_root)

last_excution()

set_last_execution(date_string)

last_strategy()

set_last_strategy(strategy)

last_sitemaps(fallback=[])

set_last_sitemaps(sitemaplist)

exp_scp_server(fallback='example.com')

set_exp_scp_server(exp_scp_server)

exp_scp_port(fallback=22)

set_exp_scp_port(exp_scp_port)

exp_scp_user(fallback='username')

set_exp_scp_user(exp_scp_user)

exp_scp_document_root(fallback='/var/www/html/')

set_exp_scp_document_root(exp_scp_document_root)

zip_filename(fallback='/home/docs/resourcesync.zip')

set_zip_filename(zip_filename)

imp_scp_server(fallback='example.com')

set_imp_scp_server(imp_scp_server)

imp_scp_port(fallback=22)

set_imp_scp_port(imp_scp_port)

imp_scp_user(fallback='username')

set_imp_scp_user(imp_scp_user)

imp_scp_remote_path(fallback='~')

set_imp_scp_remote_path(imp_scp_remote_path)

imp_scp_local_path(fallback='/home/docs')

set_imp_scp_local_path(imp_scp_local_path)

parser = <configparser.ConfigParser object>