tablexplore package

Submodules

tablexplore.app module

TablExplore app Created November 2020 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.app.Application(project_file=None, csv_file=None, excel_file=None)

Bases: QMainWindow

about()

addDockWidgets()

Add plot dialogs to dock

addRecentFile(fname)

Add file to recent if not present

addSheet(name=None, df=None, meta=None)

Add a new sheet

applySettings()

Apply settings to GUI when changed

changeColumnWidths(factor=1.1)

checkSettings()

Check for missing settings

clearSheets(ask=True)

Clear all sheets

closeEvent(event)

Close event

concatSheets()

Combine sheets into one table

copy()

createMenu()

Main menu

createToolBar()

Create main toolbar

discoverPlugins()

Discover available plugins

do_saveProject(filename, progress_callback=None)

Does the actual saving. Save sheets inculding table dataframes and meta data as dict to compressed pickle.

duplicateSheet()

Make a copy of a sheet

exportAs()

Export as

fileQuit()

findReplace()

Find or replace

getCurrentTable()

Return the currently used table

getSampleData(name, rows=None)

Sample table

importExcel(filename=None)

importFile(filename=None)

importHDF()

importMultiple()

Import many files

importMultipleFiles(folders=False)

Import many files

importPickle()

importURL()

Import from URL

interpreter()

Launch python interpreter

loadMeta(table, meta)

Load meta data for a sheet/table, this includes plot options and table selections

loadPlugin(plugin)

Instantiate the plugin and call it’s main method

loadSettings()

Load GUI settings

load_dataframe(df, name=None, select=False)

Load a DataFrame into a new sheet :param df: dataframe :param name: name of new sheet :param select: set new sheet as selected

load_pickle(filename)

Load a pickle file

mergeSheets()

Merge two sheets

newProject(data=None, ask=False)

New project

openProject(filename=None, asksave=False)

Open project file

open_url(url='', event=None)

Open the online documentation

paste()

pasteNewSheet()

plotToScratchpad(label=None)

Cache the current plot so it can be viewed later

preferences()

Preferences dialog

processing_completed()

Generic process completed

progress_fn(msg)

refresh()

Refresh all tables

removeSheet(index, ask=True)

Remove sheet

renameSheet()

Rename the current sheet

replot()

Plot current

run_threaded_process(process, on_complete)

Execute a function in the background with a worker

saveAsProject()

Save as a new project filename

saveMeta(tablewidget)

Save meta data such as current plot options and certain table attributes. These are re-loaded when the sheet is opened.

saveProject(filename=None)

Save project

saveSettings()

Save GUI settings

saveWithProgress(filename)

Save with progress bar

setTheme(theme=None)

Change interface theme.

showErrorLog()

Show log file contents

showPlotFrame()

Show/hide the plot frame

showPlugin(plugin)

Add plugin as dock widget

showRecentFiles()

Populate recent files menu

showScratchpad()

Show stored plot figures

startLogging()

Logging

stateChanged(bool)

staticMetaObject = <PySide2.QtCore.QMetaObject object>

tabSelected(index)

Re-load plot widgets for current tab

tableToScratchpad()

Send table selection to scratchpad

undo()

updatePlotWidgets(table)

Update plot widgets from values in table

updatePluginMenu()

Update plugins

updatePlugins()

Update table for a plugin if it needs it

zoomIn()

zoomOut()

tablexplore.app.main()

tablexplore.core module

Implements core classes for tablexplore Created May 2017 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.core.ColumnHeader

Bases: QHeaderView

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.core.DataFrameModel(dataframe=None, *args)

Bases: QAbstractTableModel

DataFrame Model class.

columnCount(self, parent: PySide2.QtCore.QModelIndex = Invalid(PySide2.QtCore.QModelIndex)) → int

data(index, role=PySide2.QtCore.Qt.ItemDataRole.DisplayRole)

Edit or display roles. Handles what happens when the Cells are edited or what appears in each cell. https://www.pythonguis.com/tutorials/pyside-qtableview-modelviews-numpy-pandas/

flags(self, index: PySide2.QtCore.QModelIndex) → PySide2.QtCore.Qt.ItemFlags

headerData(col, orientation, role)

What’s displayed in the headers

rowCount(self, parent: PySide2.QtCore.QModelIndex = Invalid(PySide2.QtCore.QModelIndex)) → int

setData(index, value, role=PySide2.QtCore.Qt.ItemDataRole.EditRole)

Set data upon edits

sort(idx, ascending=True)

Sort table by given column number

staticMetaObject = <PySide2.QtCore.QMetaObject object>

update(df)

class tablexplore.core.DataFrameTable(parent=None, dataframe=None, font='Arial', fontsize=12, columnwidth=80, timeformat='%m-%d-%Y', bg='#F4F4F3', **kwargs)

Bases: QTableView

QTableView with pandas DataFrame as model.

addColumn()

Add a column

addRows()

Add n rows

changeColumnWidths(factor=1.1)

Set column widths

checkColumnsUnique()

Check if columns are all unique

columnClicked(col)

columnHeaderMenu(pos)

Column header right click popup menu

contextMenuEvent(event)

Reimplemented to create context menus for cells and empty space.

deleteCells(rows, cols, answer=None)

Clear the cell contents

deleteColumn(column=None)

Delete column

deleteRows()

Delete rows

getColumnOrder()

Get column names from header in their displayed order

getColumnWidths()

getMemory()

Get memory info as string

getScrollPosition()

Get current row/col position

getSelectedColumns()

Get selected column indexes

getSelectedDataFrame()

Get selection as a dataframe

getSelectedRows()

handleDoubleClick(item)

keyPressEvent(self, event: PySide2.QtGui.QKeyEvent) → None

memory_usage()

refresh()

Refresh table if dataframe is changed

renameColumn(column=None)

resetIndex()

rowHeaderMenu(pos)

Row header popup menu

selectColumn(self, column: int) → None

setColumnType(column=None)

Change the column dtype

setColumnWidths(widths)

setIndex(column)

Set column as index

setIndexType()

Set the type of the index

setRowColor(rowIndex, color)

setScrollPosition(row, col)

Move to row/col position

setSelected(rows, cols)

Set selection programmatically from a list of rows and cols. https://doc.qt.io/archives/qtjambi-4.5.2_01/com/trolltech/qt/model-view-selection.html

showAll()

Re-show unfiltered

showSelection(item)

sort(idx, ascending=True)

Sort by selected columns

sortIndex(ascending=True)

Sort by inde,

staticMetaObject = <PySide2.QtCore.QMetaObject object>

storeCurrent()

Store current version of the table before a major change is made

undo()

Undo last change to table

updateFont()

Update the font

viewRow()

View row data

zoomIn(fontsize=None)

Zoom in table

zoomOut(fontsize=None)

Zoom out table

class tablexplore.core.DataFrameWidget(parent=None, dataframe=None, app=None, toolbar=True, statusbar=True, **kwargs)

Bases: QWidget

Widget containing a tableview and toolbars

addColumn()

addRows()

aggregate()

Groupby aggregate operation

applyColumnFunction(column)

Apply column wise functions, applies a calculation per row and ceates a new column.

applySettings(settings)

Settings

applyStringMethod(column)

Apply string operation to column(s)

applyTransformFunction(column)

Apply resampling and transform functions on a single column.

bin()

Split into bins using cut

cleanData()

Deal with missing data

clear()

Clear table

close()

Close events

closeSubtable()

convertColumnNames()

Reformat column names

convertDates(column)

Convert single or multiple columns into datetime or extract features from datetime object.

convertNumeric()

Convert cols to numeric if possible

convertTypes()

copy()

Copy to clipboard

createPlotViewer(parent=None)

Create a plot widget attached to this table

createToolbar()

Create toolbar

editMode(evt=None)

Change table edit mode

exportTable()

Export table

fillData(column)

Fill column with data

fillDates(column)

Fill with datetime

fillStrings(column)

Fill column with string data

filter()

Show filter dialog

findDuplicates()

Find or remove duplicates

findreplace()

Find/replace dialog

getFileType()

getSelectedDataFrame()

Get selection as a dataframe

importExcel(filename=None)

Import excel file

importFile(filename=None, dialog=True, **kwargs)

Import csv file

importHDF()

Import hdf5 file

importPickle()

importURL(recent)

Import hdf5 file

info()

Table info

insert()

Insert from clipboard

load()

manageColumns()

Edit columns

melt()

Melt table

merge()

paste()

Paste from clipboard

pivot()

Pivot table

plot()

Plot from selection

refresh()

resample()

Table time series resampling dialog. Should set a datetime index first.

runScript()

Run a set of python commands on the table

save()

selectAll()

Select all data

showAsText()

Show selection as text

showInterpreter()

Show the Python interpreter

showSubTable(df=None, title=None, index=False, out=False)

Add the child table

stateChanged(idx, idx2)

Run whenever table model is changed

staticMetaObject = <PySide2.QtCore.QMetaObject object>

statusBar()

Status bar at bottom

subTableFromSelection()

transpose()

updateStatusBar()

Update the table details in the status bar

class tablexplore.core.HeaderProxyStyle

Bases: QProxyStyle

drawControl(self, element: PySide2.QtWidgets.QStyle.ControlElement, option: PySide2.QtWidgets.QStyleOption, painter: PySide2.QtGui.QPainter, widget: Union[PySide2.QtWidgets.QWidget, NoneType] = None) → None

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.core.HeaderView(parent)

Bases: QHeaderView

” Column header class.

sectionSizeFromContents(logicalIndex)

Get section size from contents

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.core.ItemEditorFactory

Bases: QItemEditorFactory

createEditor(self, userType: int, parent: PySide2.QtWidgets.QWidget) → PySide2.QtWidgets.QWidget

class tablexplore.core.RowHeader

Bases: QHeaderView

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.core.SubTableWidget(parent=None, dataframe=None, **args)

Bases: DataFrameWidget

Widget for sub table

createToolbar()

Override default toolbar

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.core.SubWidget(parent, table)

Bases: QDockWidget

closeEvent(self, event: PySide2.QtGui.QCloseEvent) → None

staticMetaObject = <PySide2.QtCore.QMetaObject object>

tablexplore.dialogs module

Implements some dialog utilities for tablexplore Created Feb 2019 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.dialogs.AggregateDialog(parent, df, title='Groupby-Aggregate')

Bases: BasicDialog

Qdialog with multiple inputs

apply()

Do the operation

createWidgets()

Create widgets

customButtons()

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.BasicDialog(parent, df, title=None, app=None)

Bases: QDialog

Qdialog for table operations interfaces

apply()

Override this

close(self) → bool

copy_to_clipboard()

Copy result to clipboard

copy_to_sheet()

Copy result to new sheet in app, if available

copy_to_subtable()

Do the operation

createButtons(parent)

createWidgets()

Create widgets - override this

export()

export result to file

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.ColorButton(*args, color=None, **kwargs)

Bases: QPushButton

Custom Qt Widget to show a chosen color.

Left-clicking the button shows the color-chooser, while right-clicking resets the color to None (no-color).

color()

colorChanged

mousePressEvent(self, e: PySide2.QtGui.QMouseEvent) → None

onColorPicker()

Show color-picker dialog to select color. Qt will use the native dialog by default.

setColor(color)

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.ComboDelegate(parent, items)

Bases: QItemDelegate

A delegate to add QComboBox in every cell of the given column

createEditor(self, parent: PySide2.QtWidgets.QWidget, option: PySide2.QtWidgets.QStyleOptionViewItem, index: PySide2.QtCore.QModelIndex) → PySide2.QtWidgets.QWidget

currentIndexChanged()

setEditorData(self, editor: PySide2.QtWidgets.QWidget, index: PySide2.QtCore.QModelIndex) → None

setModelData(self, editor: PySide2.QtWidgets.QWidget, model: PySide2.QtCore.QAbstractItemModel, index: PySide2.QtCore.QModelIndex) → None

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.ConvertTypesDialog(parent, df, title='Convert types')

Bases: BasicDialog

Dialog to melt table

apply()

Do the operation

createButtons(parent)

createWidgets()

Create widgets

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.FilterBar(parent, table)

Bases: QWidget

Single Widget based filter

createWidgets()

Create widgets

getFilter()

Get filter values for this instance

onClose(ce)

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.FilterDialog(parent, table, title=None, app=None)

Bases: QWidget

Qdialog for table query/filtering

addFilter()

Add a filter using widgets

apply()

Apply filters

applyWidgetFilters(df, mask=None)

Apply the widget based filters, returns a boolean mask

copyResult()

createToolBar(parent)

createWidgets()

Create widgets

onClose()

refresh()

Reset the table

removeFiltered()

Subtract current filtered result from original table

staticMetaObject = <PySide2.QtCore.QMetaObject object>

togglecase()

update()

Update the column widgets if table has changed

class tablexplore.dialogs.FindReplaceDialog(parent, table, title=None, app=None)

Bases: QWidget

Qdialog for table query/filtering

clear()

createToolBar(parent)

createWidgets()

Create widgets

find()

Do string search. Creates a masked dataframe for results and then stores each cell coordinate in a list.

findAll()

Apply

findNext()

Show next cell of search results

onClose()

replace()

Replace all instances of search text

staticMetaObject = <PySide2.QtCore.QMetaObject object>

togglecase()

class tablexplore.dialogs.ImportDialog(parent=None, filename=None)

Bases: QDialog

Provides a dialog for import settings

createButtons(parent)

createWidgets()

Create widgets

doImport()

Do the import

quit()

showText(encoding='utf-8')

Show text contents

staticMetaObject = <PySide2.QtCore.QMetaObject object>

update()

Reload previews

class tablexplore.dialogs.ManageColumnsDialog(parent, df, title='Manage Columns', app=None)

Bases: BasicDialog

Qdialog for column re-arranging

checknumeric()

Check if any cols numeric

convert()

createButtons(parent)

createWidgets()

Create widgets - override this

deduplicate()

Rename duplicate column names

delete()

sort()

staticMetaObject = <PySide2.QtCore.QMetaObject object>

undo()

update()

Update list

class tablexplore.dialogs.MeltDialog(parent, df, title='Melt')

Bases: BasicDialog

Dialog to melt table

apply()

Do the operation

createWidgets()

Create widgets

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.MergeDialog(parent, df, df2=None, title='Merge Tables', app=None)

Bases: BasicDialog

Dialog to melt table

apply()

Do the operation

createWidgets()

Create widgets

staticMetaObject = <PySide2.QtCore.QMetaObject object>

updateColumns()

class tablexplore.dialogs.MultipleFilesDialog(parent, title='Import Multiple')

Bases: QDialog

createWidgets()

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.MultipleInputDialog(parent, options=None, title='Input', width=400, height=200)

Bases: QDialog

Qdialog with multiple inputs

accept(self) → None

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.PivotDialog(parent, df, title='Pivot')

Bases: BasicDialog

Dialog to pivot table

apply()

Do the operation

createWidgets()

Create widgets

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.PlainTextEditor(parent=None, **kwargs)

Bases: QPlainTextEdit

contextMenuEvent(self, e: PySide2.QtGui.QContextMenuEvent) → None

staticMetaObject = <PySide2.QtCore.QMetaObject object>

zoom(delta)

class tablexplore.dialogs.PreferencesDialog(parent, options={})

Bases: QDialog

Preferences dialog from config parser options

apply()

Apply options to current table

createButtons(parent)

createWidgets(options)

create widgets

reset()

Reset to defaults

setDefaults()

Populate default kwds dict

staticMetaObject = <PySide2.QtCore.QMetaObject object>

updateWidgets(kwds=None)

Update widgets from stored or supplied kwds

class tablexplore.dialogs.ProgressWidget(parent=None, label='')

Bases: QDialog

Progress widget class

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.Renamer

Bases: object

class tablexplore.dialogs.SimpleDialog(parent, title=None)

Bases: QDialog

Qdialog for generic operations

createButtons()

Create buttons

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.TextDialog(parent, text='', title='Text', width=400, height=300)

Bases: QDialog

Text edit dialog

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.dialogs.Worker(fn, *args, **kwargs)

Bases: QRunnable

Worker thread for running background tasks.

run(self) → None

class tablexplore.dialogs.WorkerSignals

Bases: QObject

Defines the signals available from a running worker thread. Supported signals are: finished

No data

error

tuple (exctype, value, traceback.format_exc() )

result

object data returned from processing, anything

error

finished

progress

result

staticMetaObject = <PySide2.QtCore.QMetaObject object>

tablexplore.dialogs.addToolBarItems(toolbar, parent, items)

Populate toolbar from dict of items

tablexplore.dialogs.dialogFromOptions(parent, opts, sections=None, wrap=2, section_wrap=4, style=None)

Get Qt widgets dialog from a dictionary of options. :param opts: options dictionary :param sections: :param section_wrap: how many sections in one row :param style: stylesheet css if required

tablexplore.dialogs.getName(parent, current='', txt='Enter value')

Wrapper for text inpuit dialog

tablexplore.dialogs.getWidgetValue(w)

Get value from any kind of widget

tablexplore.dialogs.getWidgetValues(widgets)

Get values back from a set of widgets

tablexplore.dialogs.setWidgetValues(widgets, values)

Set values for a set of widgets from a dict

tablexplore.dialogs.showMessage(parent, msg, type='error')

Show an error message

tablexplore.interpreter module

Implements a Python interpreter From original code from https://github.com/col-one/thonside

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.interpreter.Interpreter(extra_context={}, stream_out=True, stream_err=True, table=None, app=None)

Bases: InteractiveConsole

interact(banner=None, exitmsg=None)

Starting point for the interpreter. It is override for avoid while loop as classic shell. In this context interpreter doesn’t use this functionality. :param banner: starter text :param exitmsg: no used :return:

raw_input(prompt='')

Override InteractiveConsole.raw_input method to add a ‘slot’ connection, useful for different view implementation. :param prompt: str prompt to write :return:

run(code)

Manage run code, like continue if : or ( with prompt switch >>> to … :param code: str code to run :return:

runcode(code)

Override InteractiveConsole.runcode method to manage stdout as a buffer. Useful for view implementation. :param code: str code to run :return:

write(data)

Override InteractiveConsole.write method to add a ‘slot’ connection, useful for different view implementation. :param data: str data to write :return:

class tablexplore.interpreter.Streamer(queue)

Bases: object

flush()

write(text)

class tablexplore.interpreter.TerminalPython(parent=None, table=None, app=None)

Bases: Terminal

staticMetaObject = <PySide2.QtCore.QMetaObject object>

tablexplore.plotting module

tableexplore plotting module Created May 2017 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.plotting.AnnotationOptions

Bases: BaseOptions

This class also provides custom tools for adding items to the plot

applyOptions()

Set the plot kwd arguments from the tk variables

class tablexplore.plotting.AxesOptions

Bases: BaseOptions

Class for additional formatting options like styles

class tablexplore.plotting.BaseOptions

Bases: object

Class to generate widget dialog for dict of options

apply()

applyOptions()

Set the plot kwd arguments from the widgets

increment(key, inc)

Increase the value of a widget

randomSettings()

Get random settings

setDefaults()

Populate default kwds dict

setWidgetValue(key, value)

showDialog(parent, wrap=2, section_wrap=2, style=None)

Auto create widgets for corresponding options and

and return the dialog.

Parameters:

• parent – parent frame

• wrap – wrap for internal widgets

updateWidgets(kwds=None)

Update widgets from stored or supplied kwds

class tablexplore.plotting.FormatOptions

Bases: BaseOptions

This class also provides custom tools for adding items to the plot

class tablexplore.plotting.MPLBaseOptions

Bases: BaseOptions

Class to provide a dialog for matplotlib options and returning the selected prefs

legendlocs = ['best', 'upper right', 'upper left', 'lower left', 'lower right', 'right', 'center left', 'center right', 'lower center', 'upper center', 'center']

update(df)

Update data widget(s) when dataframe changes

class tablexplore.plotting.PlotViewer(table, parent=None)

Bases: QWidget

Plot viewer class

addPlotWidget()

Create mpl plot canvas and toolbar

applyPlotoptions()

Apply the current plotter/options

autoscale(axis='y')

Set all subplots to limits of largest range

bar3D(data, ax, kwds)

3D bar plot

canvasResize(pad=50)

Trigger resize canvas

checkColumnNames(cols)

Check length of column names

check_kwds(kwds, kind)

clear()

Clear plot

colorsfromColormap(df, cmap)

Column colors from cmap

contourData(data)

Get data for contour plot

createOptions()

Create option attributes for plotter

createWidgets()

Create widgets. Plot on left and dock for tools on right.

customPlot()

plot custom series

customiseSeries()

Show custom options for current plot series. Allows plot types to be specified per series and uses a custom plot function.

dotplot(df, ax, kwds)

Dot plot

getFigureSize()

getSeries(data)

getView()

getcmap(name)

heatmap(df, ax, kwds)

Plot heatmap

meshData(x, y, z)

Prepare 1D data for plotting in the form (x,y)->Z

plot()

plot2D(redraw=True)

Plot method for current data. Relies on pandas plot functionality if possible. There is some temporary code here to make sure only the valid plot options are passed for each plot kind.

plot3D(redraw=True)

3D plot

plotBySeries()

Plot different types depending on series

plotCurrent(redraw=True)

Plot the current data

replot(data=None)

Replot with given dataframe

savePlot(filename=None)

Save the current plot

scatter(df, ax, axes_layout='single', alpha=0.8, marker='o', color=None, **kwds)

A custom scatter plot rather than the pandas one. By default this plots the first column selected versus the others

scatter3D(data, ax, kwds)

3D scatter plot

setAxisLabels(ax, kwds)

Set a plots axis labels

setFigure(figure)

Recreate canvas with given figure

setFigureOptions(axs, kwds)

Set axis wide options such as ylabels, title

setStyle()

Apply style

showTools()

Show/hide tools dock

showWarning(text='plot error', ax=None)

Show warning message in the plot window

simple_plot(df)

test plot

staticMetaObject = <PySide2.QtCore.QMetaObject object>

updateData()

Update data widgets

updateSeries(event=None)

Update series with new plots

venn(data, ax, colormap=None, alpha=0.8)

Plot venn diagram, requires matplotlb-venn

violinplot(df, ax, kwds)

violin plot

zoom(zoomin=True)

Zoom in/out to plot by changing size of elements

class tablexplore.plotting.PlotWidget(parent=None, figure=None, dpi=100, hold=False)

Bases: FigureCanvasQTAgg

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.plotting.SeriesOptions(plotviewer)

Bases: BaseOptions

Class for selecting custom plot types for each series

close()

createButtons(parent)

createSeriesWidgets(parent)

showDialog(parent=None)

Auto create widgets for corresponding options and

and return the dialog.

Parameters:

• parent – parent frame

• wrap – wrap for internal widgets

update(event=None)

Update series options from widgets and replot

tablexplore.plotting.addFigure(parent, figure=None, resize_callback=None)

Create a tk figure and canvas in the parent frame

tablexplore.plotting.defaultOptions()

Get default plotting options

tablexplore.plotting.load_colormaps()

tablexplore.plotting.update_colormaps()

Load stored colormaps

tablexplore.plugin module

TablExplore plugin class Created January 2021 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.plugin.Plugin(parent=None)

Bases: object

Base Plugin class, should be inherited by any plugin

capabilities = []

createWidgets(width=600, height=600)

Create main widget with GUI elements. This will be specific to the plugin so it must be overrriden.

main(parent=None)

menuentry = ''

quit(evt=None)

requires = []

tablexplore.plugin.describe_class(obj)

Describe the class object passed as argument, including its methods

tablexplore.plugin.describe_func(obj, method=False)

Describe the function object passed as argument. If this is a method object, the second argument will be passed as True

tablexplore.plugin.find_plugins()

tablexplore.plugin.get_plugins_classes(capability)

Returns classes of available plugins

tablexplore.plugin.get_plugins_instances(capability)

Returns instances of available plugins

tablexplore.plugin.init_plugin_system(folders)

Find available plugins

tablexplore.plugin.load_plugins(plugins)

Load plugins

tablexplore.plugin.parsefolder(folder)

Parse for all .py files in plugins folder or zip archive

tablexplore.qt module

TablExplore app Created January 2021 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

tablexplore.terminal module

Implements some dialog utilities for tableexplore Created Feb 2019 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.terminal.ExecThread

Bases: QObject

cmd = None

def_to_run = None

finished

run()

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.terminal.QueueReceiver(queue, *args, **kwargs)

Bases: QObject

run()

sent

staticMetaObject = <PySide2.QtCore.QMetaObject object>

class tablexplore.terminal.Terminal(parent=None, hist_file=None)

Bases: QPlainTextEdit

active_queue_thread(queue)

autocomplete(command)

Ask different possibility from command arg, proposition is limited by AUTOCOMPLETE_LIMIT constant :param command: str :return: list of proposition

closeEvent(self, event: PySide2.QtGui.QCloseEvent) → None

contextMenuEvent(self, e: PySide2.QtGui.QContextMenuEvent) → None

count_cursor_lines()

Slot def keep tracking cursor position line number. Useful to compare position to know if it is an editable line or not. :return:

exec_code(cmd)

get_command()

Get command, read last line and remove prompt length. :return: str command

get_cursor_position()

Get cursor position :return: int line cursor position.

get_last_line()

Get last terminal line. :return: str last line

get_next_history()

Get next history in the readline GNU history file. :return: str history

get_previous_history()

Get previous history in the readline GNU history file. :return: str history

init_history(hist_file)

History initialisation with readline GNU, and use hook atexit for save history when program closing. :param hist_file: history file path :return:

keyPressEvent(event)

Override to manage key board event. :param event: event key. :return:

press_enter

raw_input(prompt=None)

Use to write the prompt command. :param prompt: str prompt :return:

remove_last_command()

Remove current command. Useful for display history navigation. :return:

remove_last_line()

save_history(hist_file)

Hook def execute by atexit. :param hist_file: history file path :return:

setStyle(self, arg__1: PySide2.QtWidgets.QStyle) → None

staticMetaObject = <PySide2.QtCore.QMetaObject object>

write(data)

Append text to the Terminal. And keep cursor at the end. :param data: str data to write. :return:

write_autocomplete(command)

Prepare text to write. :param command: str command :return:

write_prompt(data)

Append text to the Terminal. And keep cursor at the end. :param data: str data to write. :return:

zoom(delta)

tablexplore.util module

Implements the utility methods for tableexplore classes. Created August 2015 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

tablexplore.util.adjustColorMap(cmap, minval=0.0, maxval=1.0, n=100)

Adjust colormap to avoid using white in plots

tablexplore.util.checkDict(d)

Check a dict recursively for non serializable types

tablexplore.util.checkOS()

Check the OS we are in

tablexplore.util.check_multiindex(index)

Check if index is a multiindex

tablexplore.util.colorScale(hex_color, brightness_offset=1)

Takes a hex color and produces a lighter or darker variant. :returns: new color in hex format

tablexplore.util.gen_colors(cmap, n, reverse=False)

Generates n distinct color from a given colormap. :param cmap: The name of the colormap you want to use.

Refer https://matplotlib.org/stable/tutorials/colors/colormaps.html to choose Suggestions: For Metallicity in Astrophysics: Use coolwarm, bwr, seismic in reverse For distinct objects: Use gnuplot, brg, jet,turbo.

Parameters:

• n (int) – Number of colors you want from the cmap you entered.

• reverse (bool) – False by default. Set it to True if you want the cmap result to be reversed.

Returns:

A list with hex values of colors.

Return type:

colorlist(list)

Taken from the mycolorpy package by binodbhttr see also https://matplotlib.org/stable/tutorials/colors/colormaps.html

tablexplore.util.gen_lower(n=2)

Generate lower case words

tablexplore.util.gen_upper(n=2)

Generate upper case words

tablexplore.util.gen_word(n=2)

Generate words with strings or symbols

tablexplore.util.getAttributes(obj)

Get non hidden and built-in type object attributes that can be persisted

tablexplore.util.getEmptyData(rows=10, columns=4)

tablexplore.util.getFonts()

Get the current list of system fonts

tablexplore.util.getPresetData(name)

Get iris dataset

tablexplore.util.getSampleData(rows=400, cols=5, namelen=2)

Generate sample data

tablexplore.util.get_user_config_directory()

Returns a platform-specific root directory for user config settings.

tablexplore.util.hex_to_rgb(value)

tablexplore.util.random_colors(n=10, seed=1)

Generate random hex colors as list of length n.

tablexplore.util.setAttributes(obj, data)

Set attributes from a dict. Used for restoring settings in tables

tablexplore.util.show_colors(colors, ax=None)

display a list of colors

tablexplore.util.valueToBool(value)

tablexplore.widgets module

Implements various widgets for tablexplore Created Oct 2021 Copyright (C) Damien Farrell

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

class tablexplore.widgets.ScratchPad(parent=None)

Bases: QWidget

Temporary storage widget for plots and other items. Currently supports storing text, mpl figures and dataframes

clear()

Clear plots

closeEvent(event)

Close

createWidgets()

Create widgets. Plot on left and dock for tools on right.

newText()

Add a text editor

remove(idx)

Remove selected tab and item widget

save()

Save selected item

saveAll()

Save all figures in a folder

staticMetaObject = <PySide2.QtCore.QMetaObject object>

update(items)

Display a dict of stored objects

Module contents