rsudp.c_settings (Settings)

class rsudp.c_settings.Settings

Added in version 2.0.1.

Сlass processes configuration files.

static default_settings(output_dir='/home/runner/rsudp', verbose=True)

Returns a Settings dict of default settings.

Parameters:

  • output_dir (str) – the user’s specified output location. defaults to ~/rsudp.

  • verbose (bool) – if True, displays some information as the string is created.

Returns:

Settings

Return type:

Settings

dump(loc: str)

Dumps a default settings file to a specified location.

Parameters:

loc (str) – The location to create the new settings JSON.

property json

Convert Settings to json string

Returns:

JSON string

Return type:

str

static read_settings(loc: str)

Reads settings from a specific location.

Parameters:

loc (str) – location on disk to read json settings file from

Returns:

settings dictionary read from JSON, or None

Return type:

Settings or NoneType

Back to top ↑