parsley.gui package

Submodules

parsley.gui.apidef module

Interface for publishing api information to the gui and for querying that infos.

class parsley.gui.apidef.InvalidUserFeedbackController

Bases: object

parsley.gui.apidef.getfsname(fs, i)

Returns a name for a filesystem (even if no ‘name’ param is set).

Parameters
Return type

str

parsley.gui.apidef.getnumstring(i)

Returns a nice index representation, like ‘2nd’ for 2.

Parameters

i (int) –

Return type

str

parsley.gui.apidef.getregisteredchangeguides()

Returns a list of all registered graphical change guides. See registerchangeguide.

parsley.gui.apidef.getregisteredfilesystemhelpers()

Returns a list of all registered filesystem implementations (together with gui helpers). See registerfilesystem.

parsley.gui.apidef.registerchangeguide()

Returns a function that registers a graphical change guide. A change guide is a graphical dialog (mostly with messageboxes, inputboxes, choiceboxes) that helps the user to configure a certain part of parsley functionality.

parsley.gui.apidef.registerfilesystemhelper(clss)

Returns a function that registers a filesystem implementation (together with gui helpers). This is mostly used for providing graphical aid in making a parsley configuration.

parsley.gui.helpers module

class parsley.gui.helpers.ParsleyRunThread(listener, datadir, configfile, syncname)

Bases: threading.Thread

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is the argument tuple for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

Parameters
cancel()
Return type

None

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

class parsley.gui.helpers.ParsleyRunThreadListener

Bases: object

abstract ended(returnvalue)
Parameters

returnvalue (int) –

Return type

None

abstract output(txt)
Parameters

txt (str) –

Return type

None

parsley.gui.helpers._translator()
Return type

Callable[[str], str]

parsley.gui.helpers.call_parsley_tool(toolname, *, syncname, datadir)
Parameters

  • toolname (str) –

  • syncname (str) –

  • datadir (str) –

Return type

None

parsley.gui.helpers.find_volume_rootpath(path)
Parameters

path (str) –

Return type

Optional[str]

parsley.gui.helpers.get_volume_paths_for_sync(syncname, *, datadir)
Parameters

  • syncname (str) –

  • datadir (str) –

Return type

List[str]

parsley.gui.helpers.openconfig(cfgfile)
Parameters

cfgfile (str) –

Return type

Optional[parsley.config.config.ParsleyConfiguration]

parsley.gui.helpers.parsley_cmdline(*params, toolname='parsley')
Parameters

  • params (str) –

  • toolname (str) –

Return type

List[str]

parsley.gui.helpers.saveconfig(cfg)
Parameters

cfg (parsley.config.config.ParsleyConfiguration) –

Return type

None

parsley.gui.report module

class parsley.gui.report.LogMessageWithTime(logmessage, time)

Bases: object

Parameters
class parsley.gui.report.PerformanceData(syncruns, eventhandlers, filesystems, timingdata)

Bases: object

Parameters

  • syncruns (List[str]) –

  • eventhandlers (List[str]) –

  • filesystems (List[str]) –

  • timingdata (Dict[str, PerformanceData.Sync]) –

class EventHandler(name, eventname)

Bases: object

Parameters

  • name (str) –

  • eventname (str) –

class Filesystem(name)

Bases: object

Parameters

name (str) –

class Loader

Bases: object

classmethod __read_events(_levents, _eventlist, _eventhandlerset, _filesystemset)
add_data_available_changed_handler(fct)
add_query_result_available_changed_handler(fct)
property data_available
Return type

bool

Return type

bool

Return type

bool

get_data()
Return type

parsley.gui.report.PerformanceData

get_query_result()
Return type

parsley.gui.report.PerformanceData.QueryResult

query(*, horizontally, vertically, aggregation, sync=None, syncrun=None, eventhandler=None, filesystem=None, path=None)
Parameters

  • horizontally (str) –

  • vertically (str) –

  • aggregation (str) –

  • sync (Optional[str]) –

  • syncrun (Optional[str]) –

  • eventhandler (Optional[str]) –

  • filesystem (Optional[str]) –

  • path (Optional[str]) –

property query_result_available
Return type

bool

Return type

bool

Return type

bool

set_path(path)
Parameters

path (str) –

Return type

None

class Path(path)

Bases: object

Parameters

path (str) –

class QueryResult(row_names, column_names, result)

Bases: object

Parameters

  • row_names (List[str]) –

  • column_names (List[str]) –

  • result (List[List[float]]) –

class Sync(name)

Bases: object

Parameters

name (str) –

class SyncRun(name)

Bases: object

Parameters

name (str) –

class Table

Bases: object

add(rowname, colname, value)
Parameters

  • rowname (str) –

  • colname (str) –

  • value (float) –

Return type

None

property eventhandlers
Return type

t.List[str]

Return type

t.List[str]

Return type

t.List[str]

property filesystems
Return type

t.List[str]

Return type

t.List[str]

Return type

t.List[str]

property syncruns
Return type

t.List[str]

Return type

t.List[str]

Return type

t.List[str]

property synctasks
Return type

t.List[str]

Return type

t.List[str]

Return type

t.List[str]

property timingdata
Return type

t.Dict[str, ‘PerformanceData.Sync’]

Return type

t.Dict[str, ‘PerformanceData.Sync’]

Return type

t.Dict[str, ‘PerformanceData.Sync’]

class parsley.gui.report.SyncRunLog(sync, syncrun, messages, begintime, endtime, crashed)

Bases: object

Parameters
parsley.gui.report.try_load_log_from_syncdir(path, sync='?')
Parameters

  • path (str) –

  • sync (str) –

Return type

List[parsley.gui.report.SyncRunLog]

Module contents

Graphical user interfaces.