src.core.analyse.plugin module

contains the plugin support

src.core.analyse.plugin.ApplyTemplate(pathToTemplateFile, customLocation='', customSize=())

this method applys certain modules in the plugin folder as expressed in the procedure .json file.

Parameters:

• pathToTemplateFile (str) – the path to the .json procedure

• customLocation (str, optional) – if passed, saves the picture generated into the passed path, instead of the location specified in the plugin file.

• customSize (tuple[int, int])

src.core.analyse.plugin.executePlugin(frames, plugname, customLocation='', customSize=(), args={})

Parameters:

• frames (DataFrame)

• plugname (str)

• customLocation (str)

• customSize (tuple[int, int])

• args (dict)

src.core.analyse.plugin.getData(plug_module, modname)

returns a dict with the members of a module for further use

Parameters:

• plug_module – a module, which is located in the plugins folder

• modname (str)

Returns:

use_dict – a dict containing name and member as key/value

Return type:

dict

src.core.analyse.plugin.getDataFrameIdent(data)

returns the identification list-tuple of a dataframe

Parameters:

data (list[pd.DataFrame]) – any list of pandas dataframe

Returns:

ident – the ident of the passed dataframe

Return type:

list[tuple]

src.core.analyse.plugin.getPlugins(specific=[])

returns a dict of all modules in plugins, with name as key and module as value.

Parameters:

specific (list[str], optional) – a list of modules we want to check only for

Returns:

modules – name as keys, modules as values of the plugins folder

Return type:

dict

src.core.analyse.plugin.getPossiblePlots(queries)

calculates dependant on a sql query, which possible plots there are

Parameters:

queries (str) – a sql query as a string

Returns:

data – a list of all modules with their funcs

Return type:

list[list[str]]

src.core.analyse.plugin.isLayoutApplicable(data, plug_module)

checks if a module is applicable for a certain dataframe

Parameters:

• data (list[pd.DataFrame]) – any list of pandas dataframes

• plug_module – any module of the plugins folder

Returns:

isApplicable

Return type:

bool

src.core.analyse.plugin.mod_location_c = 'templates/plugins'

a constant for the path, where the program will check for plugins

Dependency Diagrams (without externals):

Mode: exportMode: importMode: neighborMode: neighbor_reduced

Range 1Range 2Range 3Range 4Range 5

Import dependencies (collapsed)

Dependency Diagrams:

Mode: exportMode: importMode: neighborMode: neighbor_reduced

Range 1Range 2Range 3Range 4Range 5

Import dependencies (collapsed)