typhos.tools.TyphosConsole

class typhos.tools.TyphosConsole(parent=None)[source]

IPython Widget for Typhos Display.

This widget handles starting a JupyterKernel and connecting an IPython console in which the user can type Python commands. It is important to note that the kernel in which commands are executed is a completely separate process. This protects the user against locking themselves out of the GUI, but makes it difficult to pass the Device..

To get around this caveat, this widget uses happi to pass the Device between the processes. This is not a strict requirement, but if happi is not installed, users will need to create a custom add_device method if they want their devices loaded in both the GUI and console.

__init__(parent=None)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([parent])

Initialize self.

acceptDrops(self)

accessibleDescription(self)

accessibleName(self)

actionEvent(self, QActionEvent)

actions(self)

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

add_device(device)

Add a new device to the widget

adjustSize(self)

autoFillBackground(self)

backgroundRole(self)

baseSize(self)

blockSignals(self, bool)

changeEvent(self, QEvent)

childAt(self, QPoint)

childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self)

childrenRect(self)

childrenRegion(self)

clearFocus(self)

clearMask(self)

close(self)

closeEvent(self, QCloseEvent)

colorCount(self)

connectNotify(self, QMetaMethod)

contentsMargins(self)

contentsRect(self)

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self)

create(self, window, initializeWindow, …)

createWindowContainer(QWindow, parent, …)

cursor(self)

customEvent(self, QEvent)

deleteLater(self)

depth(self)

destroy(self, destroyWindow, destroySubWindows)

devType(self)

devicePixelRatio(self)

devicePixelRatioF(self)

devicePixelRatioFScale()

disconnect(self)

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self)

effectiveWinId(self)

ensurePolished(self)

enterEvent(self, QEvent)

event(self, QEvent)

eventFilter(self, QObject, QEvent)

execute(script, *[, echo, check_readiness])

Execute some code in the console.

find(sip.voidptr)

findChild(self, type, name, options, …)

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

findChildren(self, type, name, options, …)

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

focusInEvent(self, QFocusEvent)

focusNextChild(self)

focusNextPrevChild(self, bool)

focusOutEvent(self, QFocusEvent)

focusPolicy(self)

focusPreviousChild(self)

focusProxy(self)

focusWidget(self)

font(self)

fontInfo(self)

fontMetrics(self)

foregroundRole(self)

frameGeometry(self)

frameSize(self)

from_device(device[, parent])

Create a new instance of the widget for a Device

geometry(self)

getContentsMargins(self)

grab(self, rectangle)

grabGesture(self, Qt.GestureType, flags, …)

grabKeyboard(self)

grabMouse(self)

grabMouse(self, Union[QCursor, Qt.CursorShape])

grabShortcut(self, Union[QKeySequence, …)

graphicsEffect(self)

graphicsProxyWidget(self)

hasFocus(self)

hasHeightForWidth(self)

hasMouseTracking(self)

hasTabletTracking(self)

height(self)

heightForWidth(self, int)

heightMM(self)

hide(self)

hideEvent(self, QHideEvent)

inherits(self, str)

initPainter(self, QPainter)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self)

inputMethodQuery(self, Qt.InputMethodQuery)

insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self)

isAncestorOf(self, QWidget)

isEnabled(self)

isEnabledTo(self, QWidget)

isFullScreen(self)

isHidden(self)

isLeftToRight(self)

isMaximized(self)

isMinimized(self)

isModal(self)

isRightToLeft(self)

isSignalConnected(self, QMetaMethod)

isVisible(self)

isVisibleTo(self, QWidget)

isWidgetType(self)

isWindow(self)

isWindowModified(self)

isWindowType(self)

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber()

killTimer(self, int)

layout(self)

layoutDirection(self)

leaveEvent(self, QEvent)

locale(self)

logicalDpiX(self)

logicalDpiY(self)

lower(self)

mapFrom(self, QWidget, QPoint)

mapFromGlobal(self, QPoint)

mapFromParent(self, QPoint)

mapTo(self, QWidget, QPoint)

mapToGlobal(self, QPoint)

mapToParent(self, QPoint)

mask(self)

maximumHeight(self)

maximumSize(self)

maximumWidth(self)

metaObject(self)

metric(self, QPaintDevice.PaintDeviceMetric)

minimumHeight(self)

minimumSize(self)

minimumSizeHint(self)

minimumWidth(self)

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber()

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

move(self, int, int)

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

nativeEvent(self, Union[QByteArray, bytes, …)

nativeParentWidget(self)

nextInFocusChain(self)

normalGeometry(self)

objectName(self)

overrideWindowFlags(self, …)

overrideWindowState(self, …)

paintEngine(self)

paintEvent(self, QPaintEvent)

paintingActive(self)

palette(self)

parent(self)

parentWidget(self)

physicalDpiX(self)

physicalDpiY(self)

pos(self)

previousInFocusChain(self)

property(self, str)

pyqtConfigure(…)

Each keyword argument is either the name of a Qt property or a Qt signal.

raise_(self)

receivers(self, PYQT_SIGNAL)

rect(self)

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

render(self, QPaintDevice, targetOffset, …)

render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))

repaint(self)

repaint(self, int, int, int, int) repaint(self, QRect) repaint(self, QRegion)

resize(self, QSize)

resize(self, int, int)

resizeEvent(self, QResizeEvent)

restoreGeometry(self, Union[QByteArray, …)

saveGeometry(self)

scroll(self, int, int)

scroll(self, int, int, QRect)

sender(self)

senderSignalIndex(self)

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAttribute(self, Qt.WidgetAttribute, on)

setAutoFillBackground(self, bool)

setBackgroundRole(self, QPalette.ColorRole)

setBaseSize(self, int, int)

setBaseSize(self, QSize)

setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCursor(self, Union[QCursor, Qt.CursorShape])

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

setFixedSize(self, int, int)

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason)

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

setGeometry(self, int, int, int, int)

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, …)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)

setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)

setMinimumHeight(self, int)

setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])

setProperty(self, str, Any)

setShortcutAutoRepeat(self, int, enabled)

setShortcutEnabled(self, int, enabled)

setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize)

setSizePolicy(self, QSizePolicy)

setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

setWindowFlag(self, Qt.WindowType, on)

setWindowFlags(self, Union[Qt.WindowFlags, …)

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Union[Qt.WindowStates, …)

setWindowTitle(self, str)

sharedPainter(self)

show(self)

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

shutdown(*[, block])

Shutdown the Jupyter Kernel.

signalsBlocked(self)

size(self)

sizeHint(self)

sizeIncrement(self)

sizePolicy(self)

stackUnder(self, QWidget)

startTimer(self, int, timerType)

statusTip(self)

style(self)

styleSheet(self)

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute)

thread(self)

timerEvent(self, QTimerEvent)

toolTip(self)

toolTipDuration(self)

tr(self, str, disambiguation, n)

underMouse(self)

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) update(self, QRegion) update(self, int, int, int, int)

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self)

visibleRegion(self)

whatsThis(self)

wheelEvent(self, QWheelEvent)

width(self)

widthMM(self)

winId(self)

window(self)

windowFilePath(self)

windowFlags(self)

windowHandle(self)

windowIcon(self)

windowIconText(self)

windowModality(self)

windowOpacity(self)

windowRole(self)

windowState(self)

windowTitle(self)

windowType(self)

x(self)

y(self)

Attributes

DrawChildren

DrawWindowBackground

IgnoreMask

PdmDepth

PdmDevicePixelRatio

PdmDevicePixelRatioScaled

PdmDpiX

PdmDpiY

PdmHeight

PdmHeightMM

PdmNumColors

PdmPhysicalDpiX

PdmPhysicalDpiY

PdmWidth

PdmWidthMM

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

destroyed

QObject = None) [signal]

device_added

kernel_is_alive

Is the Jupyter kernel alive and not shutting down?

kernel_is_ready

Is the Jupyter kernel ready?

kernel_ready

kernel_shut_down

objectNameChanged

objectNameChanged(self, str) [signal]

staticMetaObject

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowTitleChanged

windowTitleChanged(self, str) [signal]