pandastable package

Submodules

pandastable.annotation module

pandastable.app module

pandastable.core module

Implements the core pandastable classes. Created Jan 2014 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 pandastable.core.ChildToolBar(parent=None, parentapp=None)

Bases: pandastable.core.ToolBar

Smaller toolbar for child table

class pandastable.core.Table(parent=None, model=None, dataframe=None, width=None, height=None, rows=20, cols=5, showtoolbar=False, showstatusbar=False, editable=True, enable_menus=True, **kwargs)

Bases: tkinter.Canvas

A tkinter class for providing table functionality.

Parameters:

• parent – parent Frame
• model – a TableModel with some data
• dataframe – a pandas DataFrame
• width – width of frame
• height – height of frame
• rows – number of rows if creating empty table
• cols – number of columns if creating empty table
• showtoolbar – whether to show the toolbar, default False
• showstatusbar – whether to show the statusbar

addColumn(newname=None)

Add a new column

addRows(num=None)

Add new rows

adjustColumnWidths(limit=30)

Optimally adjust col widths to accomodate the longest entry in each column - usually only called on first redraw. :param limit: max number of columns to resize

aggregate()

Show aggregate dialog

applyColumnFunction(evt=None)

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

applyStringMethod()

Apply string operation to column(s)

applyTransformFunction(evt=None)

Apply resampling and transform functions on a single column.

autoAddColumns(numcols=None)

Automatically add x number of cols

autoResizeColumns()

Automatically set nice column widths and draw

checkDataEntry(event=None)

do validation checks on data entry in a widget

cleanData()

Deal with missing data

clearData(evt=None)

Delete cells from gui event

clearFormatting()

clearSelected()

Clear selections

clearTable()

Make an empty table

close(evt=None)

closeChildTable()

Close the child table

colorColumns(cols=None, color='gray')

Color visible columns

colorRows()

Color individual cells in column(s). Requires that the rowcolors dataframe has been set. This needs to be updated if the index is reset

contractColumns(factor=10)

Reduce column widths

convertColumnNames(s='_')

Convert col names so we can use numexpr

convertDates()

Convert single or multiple columns into datetime

convertNumeric()

Convert cols to numeric if possible

copy(rows, cols=None)

Copy cell contents from clipboard - overwrites table.

copyColumn()

Copy a column

copyIndex()

Copy index to a column

copyTable(event=None)

Copy from the clipboard

corrMatrix()

Correlation matrix

createCategorical()

Get a categorical column from selected

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

Add the child table

crosstab()

Cross tabulation

deleteCells(rows, cols, answer=None)

Clear the cell contents

deleteColumn(ask=True)

Delete currently selected column(s)

deleteRow(ask=False)

Delete a selected row

describe()

Create table summary

doBindings()

Bind keys and mouse clicks, this can be overriden

doCombine()

Do combine/merge operation

doExport(filename=None)

Do a simple export of the cell contents to csv

drawCellEntry(row, col, text=None)

When the user single/double clicks on a text/number cell, bring up entry window and allow edits.

drawGrid(startrow, endrow)

Draw the table grid lines

drawHighlighted()

Color an arbitrary selection of cells. Set the ‘highlighted’ attribute which is a masked dataframe of the table.

drawMultipleCells()

Draw an outline box for multiple cell selection

drawMultipleCols()

Draw multiple column selections

drawMultipleRows(rowlist)

Draw more than one row selection

drawRect(row, col, color=None, tag=None, delete=1)

Cell is colored

drawRowHeader()

User has clicked to select a cell

drawSelectedCol(col=None, delete=1, color=None, tag='colrect')

Draw a highlight rect for the current column selection

drawSelectedRect(row, col, color=None, fillcolor=None)

User has clicked to select a cell

drawSelectedRow()

Draw a highlight rect for the currently selected rows

drawText(row, col, celltxt, align=None, single_line=True)

Draw the text inside a cell area

duplicateRows()

Make copy of rows

evalBar(evt=None)

Use pd.eval to apply a function colwise or preset funcs.

evalFunction(evt=None)

Apply a function to create new columns

expandColumns(factor=10)

Reduce column widths

fillAcross(collist, rowlist)

Fill across a row, or multiple rows

fillColumn()

Fill a column with a data range

fillDown(rowlist, collist)

Fill down a column, or multiple columns

findDuplicates()

Find duplicate rows

findText(evt=None)

Simple text search in whole table

flattenIndex()

Flatten multiindex

functionsBar(evt=None)

Apply python functions from a pre-defined set, this is for stuff that can’t be done with eval strings

getCanvasPos(row, col)

Get the cell x-y coords as a fraction of canvas size

getCellCoords(row, col)

Get x-y coordinates to drawing a cell in a given row/col

getColPosition(x)

Get column position at coord

getFonts()

getGeometry(frame)

Get frame geometry

getPlotData()

Plot data from selection

getRowPosition(y)

Set row position

getRowsFromIndex(idx=None)

Get row positions from index values

getRowsFromMask(mask)

getScale()

getSelectedColumn()

Get currently selected column

getSelectedDataFrame()

Return a sub-dataframe of the selected cells. Will try to convert object types to float so that plotting works.

getSelectedRow()

Get currently selected row

getSelectedRowData()

Return a sub-dataframe of the selected rows

getSelectionValues()

Get values for current multiple cell selection

getVisibleCols(x1, x2)

Get the visible column range

getVisibleRegion()

Get visible region of canvas

getVisibleRows(y1, y2)

Get the visible row range

get_col_clicked(event)

Get column where event on the canvas occurs

get_memory()

memory usage of current table

get_row_clicked(event)

Get row where event on canvas occurs

gotonextCell()

Move highlighted cell to next cell in row or a new col

gotonextRow()

Programmatically set next row - eg. for button events

gotoprevRow()

Programmatically set previous row - eg. for button events

groupby(colindex)

Group by

handleCellEntry(row, col)

Callback for cell entry

handleEntryMenu(*args)

Callback for option menu in categorical columns entry

handle_arrow_keys(event)

Handle arrow keys press

handle_double_click(event)

Do double click stuff. Selected row/cols will already have been set with single click binding

handle_left_click(event)

Respond to a single press

handle_left_ctrl_click(event)

Handle ctrl clicks for multiple row selections

handle_left_release(event)

Handle left mouse button release event

handle_left_shift_click(event)

Handle shift click, for selecting multiple rows

handle_mouse_drag(event)

Handle mouse moved with button held down, multiple selections

handle_right_click(event)

respond to a right click

hidePlot()

Hide plot frame

hideRowHeader()

Hide the row header, must have run show() first

importCSV(filename=None, dialog=False, **kwargs)

Import from csv file

importHDF(filename=None, dialog=False, **kwargs)

insertRow()

Insert a new row

isInsideTable(x, y)

Returns true if x-y coord is inside table bounds

load(filename=None)

load from a file

loadExcel(filename=None)

Load excel file

loadPrefs(prefs=None)

Load preferences from defaults

melt()

Melt table

merge(table)

Merge with another table.

mouse_wheel(event)

Handle mouse wheel scroll for windows

moveColumns(names=None, pos='start')

Move column(s) to start/end, used for large tables

movetoSelection(row=None, col=0, idx=None, offset=0)

Move to a specific row/col, updating table

new()

Clears all the data and makes a new table

paste(event=None)

Paste a new table from the clipboard

pivot()

Pivot table

placeColumn(col1, col2)

Move col1 next to col2, useful for placing a new column made from the first one next to it so user can see it easily

plot3D()

plotSelected()

Plot the selected data in the associated plotviewer

popupMenu(event, rows=None, cols=None, outside=None)

Add left and right click behaviour for canvas, should not have to override this function, it will take its values from defined dicts in constructor

query(evt=None)

Do query

queryBar(evt=None)

Query/filtering dialog

recalculateFunctions(omit=None)

Re evaluate any columns that were derived from functions and dependent on other columns (except self derived?)

redraw(event=None, callback=None)

Redraw table

redrawCell(row=None, col=None, recname=None, colname=None)

Redraw a specific cell only

redrawVisible(event=None, callback=None)

Redraw the visible portion of the canvas. This is the core redraw method. Refreshes all table elements. Called by redraw() method as shorthand.

Parameters:

• event – tkinter event to trigger method, default None
• callback – function to be called after redraw, default None

remove()

Close table frame

renameIndex()

Rename the row index

resample()

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

resetColors()

resetIndex(ask=True, drop=False)

Reset index and redraw row header

resizeColumn(col, width)

Resize a column by dragging

resized(event)

Check if size changed when event triggered to avoid unnecessary redraws

save()

Save current file

saveAs(filename=None)

Save dataframe to file

selectAll(evt=None)

Select all rows and cells

selectNone()

Deselect current, called when table is redrawn with completely new cols and rows e.g. after model is updated.

setAlignment(colnames=None)

Set column alignments, overrides global value

setColPositions()

Determine current column grid positions

setColorByMask(col, mask, clr)

Color individual cells in a column using a mask.

setColorbyValue()

Set row colors in a column by values

setColumnColors(cols=None, clr=None)

Set a column color and store it

setColumnType()

Change the column dtype

setFont()

Set font tuple

setPrecision(x, p)

Set precision of a float value

setRowColors(rows=None, clr=None, cols=None)

Set rows color from menu. :param rows: row numbers to be colored :param clr: color in hex :param cols: column numbers, can also use ‘all’

setRowHeight(h)

Set the row height

setSelectedCells(startrow, endrow, startcol, endcol)

Set a block of cells selected

setSelectedCol(col)

Set currently selected column

setSelectedRow(row=None)

Set currently selected row and reset multiple row list

setSelectedRows(rows)

setTheme(name='light')

Set theme

setWrap()

Toogle column header wrap

set_defaults()

Set default settings

set_rowcolors_index()

set_xviews(*args)

Set the xview of table and col header

set_yviews(*args)

Set the xview of table and row header

setcellbackgr()

setgrid_color()

setindex()

Set indexes

setrowselectedcolor()

Set selected row color

show(callback=None)

Adds column header and scrollbars and combines them with the current table adding all to the master frame provided in constructor. Table is then redrawn.

showAll()

Re-show unfiltered

showIndex()

Show the row index

showInfo()

Show dataframe info

showPlot()

showPlotViewer(parent=None)

Create plot frame

showPreferences()

Preferences dialog

showRowHeader()

Show the row header if hidden, must have run show() first

show_progress_window(message=None)

Show progress bar window for loading of data

showasText()

Get table as formatted text - for printing

sortColumnIndex()

Sort the column header by the current rows values

sortTable(columnIndex=None, ascending=1, index=False)

Sort rows based on currently selected columns

statsViewer()

Show model fitting dialog

storeCurrent()

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

tableChanged()

Callback to be used when dataframe changes so that other widgets and data can be updated

tableFromSelection()

Create a new table from the selected cells

transform()

Apply element-wise transform

transpose()

Transpose table

undo(event=None)

Undo last major table change

updateFunctions()

Remove functions if a column has been deleted

updateModel(model=None)

Should call this method when a new table model is loaded. Recreates widgets and redraws the table.

updateWidgets()

Update some dialogs when table changed

update_rowcolors()

Update row colors if present so that it syncs with current dataframe.

valueCounts()

Value counts for column(s)

values_to_colors(x, cmap='jet', alpha=1)

Convert columnn values to colors

zoomIn()

Zoom in, increases font and row heights.

zoomOut()

Zoom out, decreases font and row heights.

class pandastable.core.ToolBar(parent=None, parentapp=None)

Bases: tkinter.ttk.Frame

Uses the parent instance to provide the functions

class pandastable.core.statusBar(parent=None, parentapp=None)

Bases: tkinter.ttk.Frame

Status bar class

update()

Update status bar

pandastable.data module

Module implementing the Data class that manages data for it’s associated PandasTable.

Created Jan 2014 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 pandastable.data.TableModel(dataframe=None, rows=20, columns=5)

Bases: object

A data model for the Table class that uses pandas

Parameters:

• dataframe – pandas dataframe
• rows – number of rows if empty table
• columns – number of columns if empty table

addColumn(colname=None, dtype=None, data=None)

Add a column

autoAddRows(num)

Add n rows to end of dataframe. Will create rows with index starting from highest previous row count

copyIndex()

Copy index to a column

deleteCells(rows, cols)

deleteColumn(colindex)

delete a column

deleteColumns(cols=None)

Remove all cols or list provided

deleteRow(row, unique=True)

Delete a row

deleteRows(rowlist=None, unique=True)

Delete multiple or all rows

filterby()

getColumnCount()

Returns the number of columns in the data model

getColumnName(columnIndex)

Returns the name of the given column by columnIndex

getColumnType(columnIndex)

Get the column type

classmethod getIrisData()

Get iris dataset

getRecordAtRow(rowindex)

Get the entire record at the specifed row

getRowCount()

Returns the number of rows in the table model.

classmethod getSampleData(rows=400, cols=5, n=2)

Generate sample data :param rows: no. of rows :param cols: columns :param n: length of column names

classmethod getStackedData()

Get a dataframe to pivot test

getValueAt(row, col)

Returns the cell value at location specified by columnIndex and rowIndex.

getlongestEntry(colindex, n=500)

Get the longest string in the column for determining width. Just uses the first n rows for speed

groupby(cols)

Group by cols

initialiseFields()

Create meta data fields

insertRow(row)

Inserts a row at the required index by append/concat

keywords = {'colors': 'colors'}

load(filename, filetype=None)

Load file, if no filetype given assume it’s pickle format

moveColumn(oldindex, newindex)

Changes the order of columns

query()

resetIndex(drop=False)

Reset index behaviour

save(filename)

Save dataframe

setValueAt(value, row, col, df=None)

Change dataframe according to row/col numbers. You can also pass an arbitrary dataframe here.

setindex(colindex)

Index setting behaviour

setup(dataframe, rows=20, columns=5)

Create table model

transpose()

Transpose dataframe

pandastable.dialogs module

Dialog classes. Created Oct 2014 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 pandastable.dialogs.AggregateDialog(parent=None, df=None)

Bases: pandastable.dialogs.BaseDialog

Provides a frame for split-apply-combine operations

apply()

Apply operation

copyResult()

createWidgets(m)

Create a set of grp-agg-func options together

help()

Help button code

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

class pandastable.dialogs.AutoScrollbar(master=None, **kw)

Bases: tkinter.ttk.Scrollbar

A scrollbar that hides itself if it’s not needed. only works if you use the grid geometry manager.

pack(**kw)

place(**kw)

set(lo, hi)

Set the fractional values of the slider position (upper and lower ends as value between 0 and 1).

class pandastable.dialogs.BaseDialog(parent=None, df=None, title='')

Bases: tkinter.ttk.Frame

Generic dialog - inherit from this and customise the createWidgets and apply methods.

apply()

Code to run when Apply is pressed

buttonsFrame()

createWidgets(m)

Override this

help()

Help button code

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

class pandastable.dialogs.BaseTable(parent=None, width=280, height=190, rows=2, cols=2, **kwargs)

Bases: tkinter.Canvas

Basic table class based on tk canvas. inherit from this to add your own functionality

doBindings()

drawGrid()

drawMultipleCells(rows, cols)

Draw more than one row selection

drawSelectedRect(row, col, color='#c2c2d6', pad=4, tags='')

User has clicked to select area

getCellCoords(row, col)

Get x-y coordinates to drawing a cell in a given row/col

get_col_clicked(event)

Get column where event on the canvas occurs

get_row_clicked(event)

Get row where event on canvas occurs

handle_left_click(event)

Respond to a single press

handle_mouse_drag(event)

Handle mouse moved with button held down, multiple selections

redraw()

update()

Enter event loop until all pending events have been processed by Tcl.

class pandastable.dialogs.CombineDialog(parent=None, df1=None, df2=None)

Bases: tkinter.ttk.Frame

Provides a frame for setting up merge/combine operations

apply()

Apply operation

getResult(df)

Show result of merge and let user choose to replace current table

help()

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

replaceTable()

replace parent table

class pandastable.dialogs.CrosstabDialog(parent=None, df=None, title='')

Bases: pandastable.dialogs.BaseDialog

apply()

Apply crosstab

createWidgets(m)

Create a set of grp-agg-func options together

help()

Help button code

class pandastable.dialogs.EasyListbox(parent, width, height, yscrollcommand, listItemSelected)

Bases: tkinter.Listbox

Customised list box to replace useless default one

clear()

Deletes all items from the list box.

getIndex(item)

Returns the index of item if it’s in the list box.

getSelectedIndex()

Returns the index of the selected item or -1 if no item is selected.

getSelectedItem()

Returns the selected item or the empty string if no item is selected.

setSelectedIndex(index)

Selects the item at the index if it’s in the range.

triggerListItemSelected(event)

Strategy method to respond to an item selection in the list box. Runs the client’s listItemSelected method with the selected index.

class pandastable.dialogs.FilterBar(parent, parentframe, cols)

Bases: tkinter.ttk.Frame

Class providing filter widgets

booleanops = ['AND', 'OR', 'NOT']

close()

Destroy and remove from parent

getFilter()

Get filter values for this instance

operators = ['contains', 'excludes', 'equals', 'not equals', '>', '<', 'is empty', 'not empty', 'starts with', 'ends with', 'has length', 'is number', 'is lowercase', 'is uppercase']

update(cols)

Enter event loop until all pending events have been processed by Tcl.

class pandastable.dialogs.FindReplaceDialog(table)

Bases: tkinter.ttk.Frame

Find/replace dialog.

clear()

close()

find()

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

findAll()

Highlight all found cells

findNext()

Show next cell of search results

replace()

Replace all instances of search text

setup()

updated(name='', index='', mode='')

Widgets changed so run search again

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

Bases: tkinter.ttk.Frame

Provides a frame for figure canvas and MPL settings

doImport()

Do the import

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

showText(encoding='utf-8')

Show text contents

update()

Reload previews

class pandastable.dialogs.MultipleValDialog(parent, title=None, initialvalues=None, labels=None, types=None, tooltips=None, width=14, **kwargs)

Bases: tkinter.simpledialog.Dialog

Simple dialog to get multiple values

apply()

process the data

This method is called automatically to process the data, after the dialog is destroyed. By default, it does nothing.

body(master)

create dialog body.

return widget that should have initial focus. This method should be overridden, and is called by the __init__ method.

getResults(null=None)

Return a dict of options/values

class pandastable.dialogs.Progress(parent, side='left')

Bases: object

threaded progress bar for tkinter gui

pb_clear()

stops the progress bar

pb_complete()

stops the progress bar and fills it

pb_start()

starts the progress bar

pb_stop()

stops the progress bar

class pandastable.dialogs.ProgressDialog

Bases: tkinter.Toplevel

class pandastable.dialogs.QueryDialog(table)

Bases: tkinter.ttk.Frame

Use string query to filter. Will not work with spaces in column names, so these would need to be converted first.

addFilter()

Add a filter using widgets

applyFilter(df, mask=None)

Apply the widget based filters, returns a boolean mask

close()

colorResult()

Color filtered rows in main table

query(evt=None)

Do query

setup()

update()

Enter event loop until all pending events have been processed by Tcl.

class pandastable.dialogs.SimpleEditor(parent=None, width=100, height=40, font=None)

Bases: tkinter.ttk.Frame

Simple text editor

onClear()

Clear text

onFind()

onSave()

Save text

class pandastable.dialogs.ToolTip(widget)

Bases: object

Tooltip class for tkinter widgets

classmethod createToolTip(widget, text)

Create a tooltip for a widget

hidetip(event=None)

Hide tooltip

showtip(text, event=None)

Display text in tooltip window

class pandastable.dialogs.VerticalScrolledFrame(parent, height=None, width=None, *args, **kw)

Bases: tkinter.ttk.Frame

A pure Tkinter scrollable frame see http://tkinter.unpythonic.net/wiki/VerticalScrolledFrame. Use the ‘interior’ attribute to place widgets inside the scrollable frame.

pandastable.dialogs.addButton(frame, name, callback, img=None, tooltip=None, side='top', compound=None, width=None, padding=1)

Add a button with image, toolip to a tkinter frame

pandastable.dialogs.addListBox(parent, values=[], width=10, height=6, label='')

Add an EasyListBox

pandastable.dialogs.applyStyle(w)

Apply style to individual widget to prevent widget color issues on linux

pandastable.dialogs.dialogFromOptions(parent, opts, groups=None, callback=None, sticky='news', layout='horizontal')

Auto create tk vars and widgets for corresponding options and and return the enclosing frame

pandastable.dialogs.getBestGeometry(win, width=None)

Calculate optimal geometry from screen size or given width

pandastable.dialogs.getDictfromTkVars(opts, tkvars, widgets)

pandastable.dialogs.getListBoxSelection(w)

pandastable.dialogs.getParentGeometry(parent)

pandastable.dialogs.pickColor(parent, oldcolor)

pandastable.dialogs.setGeometry(win, width=None)

Set window geometry to center of screen

pandastable.dialogs.setWidgetStyles(widgets)

set styles of list of widgets

pandastable.handlers module

Module for plot viewer event classes.

Created Jan 2016 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 pandastable.handlers.DragHandler(parent, figure=None)

Bases: object

A simple class to handle picking and dragging

button_press_event(event)

connect()

Connect events

disconnect()

disconnect all the stored connection ids

drawSelectionRect()

Draw a selection box

key_press_event(event)

Handle key press

on_pick_event(event)

Store which text object was picked and were the pick event occurs.

on_release_event(event)

Update and store text/annotation position

pandastable.headers module

Implements the pandastable headers classes. Created Jan 2014 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 pandastable.headers.ColumnHeader(parent=None, table=None, bg='gray25')

Bases: tkinter.Canvas

Class that takes it’s size and rendering from a parent table and column names from the table model.

drawRect(col, tag=None, color=None, outline=None, delete=1)

User has clicked to select a col

draw_resize_symbol(col)

Draw a symbol to show that col can be resized when mouse here

handle_double_click(event)

Double click sorts by this column.

handle_left_click(event)

Does cell selection when left mouse button is clicked

handle_left_ctrl_click(event)

Handle ctrl clicks - for multiple column selections

handle_left_release(event)

When mouse released implement resize or col move

handle_left_shift_click(event)

Handle shift click, for selecting multiple cols

handle_mouse_drag(event)

Handle column drag, will be either to move cols or resize

handle_mouse_move(event)

Handle mouse moved in header, if near divider draw resize symbol

handle_right_click(event)

respond to a right click

handle_right_release(event)

leave(event)

Mouse left canvas event

popupMenu(event)

Add left and right click behaviour for column header

redraw(align='w')

Redraw column header

renameColumn()

Rename column

setDefaults()

within(val, l, d)

Utility funtion to see if val is within d of any items in the list l

class pandastable.headers.IndexHeader(parent=None, table=None, width=40, height=25, bg='gray50')

Bases: tkinter.Canvas

Class that displays the row index headings.

handle_left_click(event)

Handle mouse left mouse click

redraw(align='w')

Redraw row index header

class pandastable.headers.RowHeader(parent=None, table=None, width=50, bg='gray75')

Bases: tkinter.Canvas

Class that displays the row headings (or DataFrame index). Takes it’s size and rendering from the parent table. This also handles row/record selection as opposed to cell selection

clearSelected()

Clear selected rows

drawRect(row=None, tag=None, color=None, outline=None, delete=1)

Draw a rect representing row selection

drawSelectedRows(rows=None)

Draw selected rows, accepts a list or integer

handle_left_click(event)

Handle left click

handle_left_ctrl_click(event)

Handle ctrl clicks - for multiple row selections

handle_left_release(event)

handle_left_shift_click(event)

Handle shift click

handle_mouse_drag(event)

Handle mouse moved with button held down, multiple selections

handle_right_click(event)

respond to a right click

popupMenu(event, rows=None, cols=None, outside=None)

Add left and right click behaviour for canvas, should not have to override this function, it will take its values from defined dicts in constructor

redraw(align='w', showkeys=False)

Redraw row header

setWidth(w)

Set width

toggleIndex()

Toggle index display

pandastable.headers.createSubMenu(parent, label, commands)

pandastable.images module

Images stored as PhotoImage objects, for buttons and logos. Created Oct 2008 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

pandastable.images.accept()

pandastable.images.add()

pandastable.images.add_col()

pandastable.images.add_row()

pandastable.images.aggregate()

pandastable.images.calculate()

pandastable.images.color_swatch()

pandastable.images.contract_col()

pandastable.images.copy()

pandastable.images.cross()

pandastable.images.del_col()

pandastable.images.del_row()

pandastable.images.delete()

pandastable.images.end()

pandastable.images.excel()

pandastable.images.expand_col()

pandastable.images.filtering()

pandastable.images.fit()

pandastable.images.font()

pandastable.images.function()

pandastable.images.importcsv()

pandastable.images.melt()

pandastable.images.merge()

pandastable.images.new_proj()

pandastable.images.next()

pandastable.images.open_proj()

pandastable.images.paste()

pandastable.images.pivot()

pandastable.images.plot()

pandastable.images.plot_clear()

pandastable.images.plot_prefs()

pandastable.images.prefs()

pandastable.images.prev()

pandastable.images.refresh()

pandastable.images.save()

pandastable.images.save_proj()

pandastable.images.search()

pandastable.images.start()

pandastable.images.table_delete()

pandastable.images.table_multiple()

pandastable.images.tableapp_logo()

pandastable.images.tilehorizontal()

pandastable.images.tilevertical()

pandastable.images.transpose()

pandastable.images.zoom_in()

pandastable.images.zoom_out()

pandastable.plotting module

Module for pandastable plotting classes .

Created Jan 2014 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 pandastable.plotting.AnimateOptions(parent=None)

Bases: pandastable.plotting.TkOptions

Class for live update/animation of plots.

addWidgets()

Custom dialogs for manually adding annotation items like text

getWriter()

showDialog(parent, layout='horizontal')

Create dialog widgets

start()

start animation using a thread

stop()

Stop animation loop

stream()

Stream data into table and plot - not implemented yet

update()

do live updating

updateCurrent(writer=None)

Iterate over current table and update plot

class pandastable.plotting.AnnotationOptions(parent=None)

Bases: pandastable.plotting.TkOptions

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

addArrow(kwds=None, key=None)

Add line/arrow

addObject()

Add an annotation object

addTextBox(kwds=None, key=None)

Add a text annotation and store it using key

addWidgets()

Custom dialogs for manually adding annotation items like text

clear()

Clear annotations

redraw()

Redraw all stored annotations in the right places after a plot update

showDialog(parent, layout='horizontal')

Override because we need to add custom widgets

class pandastable.plotting.ExtraOptions(parent=None)

Bases: pandastable.plotting.TkOptions

Class for additional formatting options like styles

addWidgets()

Custom dialogs for manually adding annotation items like text

apply()

reset()

showDialog(parent, layout='horizontal')

Create dialog widgets

class pandastable.plotting.MPL3DOptions(parent=None)

Bases: pandastable.plotting.MPLBaseOptions

Class to provide 3D matplotlib options

applyOptions()

Set the plot kwd arguments from the tk variables

defaultfont = 'monospace'

kinds = ['scatter', 'bar', 'contour', 'wireframe', 'surface']

class pandastable.plotting.MPLBaseOptions(parent=None)

Bases: pandastable.plotting.TkOptions

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

applyOptions()

Set the plot kwd arguments from the tk variables

defaultfont = 'monospace'

kinds = ['line', 'scatter', 'bar', 'barh', 'pie', 'histogram', 'boxplot', 'violinplot', 'dotplot', 'heatmap', 'area', 'hexbin', 'contour', 'imshow', 'scatter_matrix', 'density', 'radviz', 'venn']

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 pandastable.plotting.PlotLayoutGrid(parent=None, width=280, height=205, rows=2, cols=2, **kwargs)

Bases: pandastable.dialogs.BaseTable

handle_left_click(event)

Respond to a single press

class pandastable.plotting.PlotLayoutOptions(parent=None)

Bases: pandastable.plotting.TkOptions

resetGrid(event=None)

update grid and redraw

setmultiviews(event=None)

showDialog(parent, layout='horizontal')

Override because we need to add custom bits

updateAxesList()

Update axes list

updateFromGrid()

class pandastable.plotting.PlotViewer(table, parent=None, showoptions=True)

Bases: tkinter.ttk.Frame

Provides a frame for figure canvas and MPL settings.

Parameters:

• table – parent table, required
• parent – parent tkinter frame
• layout – ‘horizontal’ or ‘vertical’

addWidgets()

Add option widgets to control panel

applyPlotoptions()

Apply the current plotter/options

autoscale(axis='y')

Set all subplots to limits of largest range

bar3D(data, ax, kwds)

3D bar plot

checkColumnNames(cols)

Check length of column names

clear()

Clear plot

close()

Close the window

contourData(data)

Get data for contour plot

dotplot(df, ax, kwds)

Dot plot

getView()

getcmap(name)

heatmap(df, ax, kwds)

Plot heatmap

meshData(x, y, z)

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

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

plotCurrent(redraw=True)

Plot the current data

plotMultiViews(plot_types=['bar', 'scatter'])

Plot multiple views of the same data in a grid

plotSplitData()

Splits selected data up into multiple plots in a grid

removeSubplot()

Remove a specific axis from the grid layout

replot(data=None)

Re-plot using current parent table selection. Args: data: set current dataframe, otherwise use current table selection

savePlot(filename=None)

Save the current plot

scatter(df, ax, 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

setFigureOptions(axs, kwds)

Set axis wide options such as ylabels, title

setGlobalOption(name='', *args)

Set global value from widgets

setOption(option, value)

setSubplotTitle()

Set a subplot title if using grid layout

setupGUI()

Add GUI elements

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

Show warning message in the plot window

toggle_options()

Show/hide plot options

updateData()

Update data widgets

updatePlot()

Update the current plot with new options

updateStyle()

updateWidgets()

Set global widgets from values

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 pandastable.plotting.TkOptions(parent=None)

Bases: object

Class to generate tkinter widget dialog for dict of options

apply()

applyOptions()

Set the plot kwd arguments from the tk variables

increment(key, inc)

Increase the value of a widget

setWidgetStyles()

showDialog(parent, layout='horizontal')

Auto create tk vars, widgets for corresponding options and and return the frame

updateFromDict(kwds=None)

Update all widget tk vars using plot kwds dict

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

Create a tk figure and canvas in the parent frame

pandastable.plotting.get_defaults(name)

pandastable.plugin module

Implements the dataexplore plugin class. Created Oct 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

class pandastable.plugin.Plugin(parent=None)

Bases: object

Base Plugin class, should be inherited by any plugin

capabilities = []

main(parent)

menuentry = ''

quit(evt=None)

requires = []

pandastable.plugin.describe_class(obj)

Describe the class object passed as argument, including its methods

pandastable.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

pandastable.plugin.find_plugins()

pandastable.plugin.get_plugins_classes(capability)

Returns classes of available plugins

pandastable.plugin.get_plugins_instances(capability)

Returns instances of available plugins

pandastable.plugin.init_plugin_system(folders)

pandastable.plugin.load_plugins(plugins)

pandastable.plugin.parsefolder(folder)

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

pandastable.config module

Implements a configuration class for pandastable Created Oct 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

pandastable.config.apply_options(options, table)

Apply options to a table

pandastable.config.check_options(opts)

Check for missing default options in dict. Meant to handle incomplete config files

pandastable.config.create_config_parser_from_dict(data=None, sections=odict_keys(['base', 'colors']), **kwargs)

Helper method to create a ConfigParser from a dict of the form shown in baseoptions

pandastable.config.get_options(cp)

Makes sure boolean opts are parsed

pandastable.config.load_options()

pandastable.config.parse_config(conffile=None)

Parse a configparser file

class pandastable.config.preferencesDialog(parent, options, table=None)

Bases: tkinter.ttk.Frame

Preferences dialog from config parser options

apply()

Apply options to current table

createWidgets()

create widgets

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

save()

Save from current dialog settings

updateFromOptions(options)

Update all widget tk vars using dict

pandastable.config.print_options(options)

Print option key/value pairs

pandastable.config.update_config(options)

pandastable.config.write_config(conffile='default.conf', defaults={})

Write a default config file

pandastable.config.write_default_config()

Write a default config to users .config folder. Used to add global settings.

pandastable.stats module

Module for stats and fitting classes.

Created June 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 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 pandastable.stats.StatsViewer(table, parent=None)

Bases: tkinter.ttk.Frame

Provides a frame for model viewing interaction

doFit()

Do model fit on selected subset of rows. Will only use the currently selected rows for fitting.

getModel(formula, data, est='ols')

Select model to use

guessFormula()

Suggest a start formula

plotLogit(fit, indvar, ax, **kwds)

Plot Logit results

plotPrediction(fit, ax)

Plot predicted vs. test

plotRegression(fit, indvar, ax, **kwds)

Plot custom statsmodels fit result for linear regression

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

setupGUI()

Add GUI elements

showPlot()

Do plots

summary()

Fit summary

updateData()

Update data widgets

pandastable.tests module

pandastable.util module

Implements the utility methods for pandastable 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

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

Adjust colormap to avoid using white in plots

pandastable.util.checkDict(d)

Check a dict recursively for non serializable types

pandastable.util.checkOS()

Check the OS we are in

pandastable.util.check_multiindex(index)

Check if index is a multiindex

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

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

pandastable.util.getAttributes(obj)

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

pandastable.util.getFonts()

Get the current list of system fonts

pandastable.util.getTextLength(text, w, font=None)

Get correct canvas text size (chars) that will fit in a given canvas width

pandastable.util.setAttributes(obj, data)

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

Module contents