repository_name
stringlengths 5
67
| func_path_in_repository
stringlengths 4
234
| func_name
stringlengths 0
314
| whole_func_string
stringlengths 52
3.87M
| language
stringclasses 6
values | func_code_string
stringlengths 52
3.87M
| func_documentation_string
stringlengths 1
47.2k
| func_code_url
stringlengths 85
339
|
|---|---|---|---|---|---|---|---|
frmdstryr/enamlx | enamlx/qt/qt_key_event.py | QtKeyEvent.set_keys | def set_keys(self, keys):
""" Parse all the key codes and save them """
codes = {}
for key in keys:
parts = [k.strip().lower() for k in key.split("+")]
code = KEYS.get(parts[-1])
modifier = Qt.KeyboardModifiers()
if code is None:
raise KeyError("Invalid key code '{}'".format(key))
if len(parts) > 1:
for mod in parts[:-1]:
mod_code = MODIFIERS.get(mod)
if mod_code is None:
raise KeyError("Invalid key modifier '{}'"
.format(mod_code))
modifier |= mod_code
if code not in codes:
codes[code] = []
codes[code].append(modifier)
self.codes = codes | python | def set_keys(self, keys):
""" Parse all the key codes and save them """
codes = {}
for key in keys:
parts = [k.strip().lower() for k in key.split("+")]
code = KEYS.get(parts[-1])
modifier = Qt.KeyboardModifiers()
if code is None:
raise KeyError("Invalid key code '{}'".format(key))
if len(parts) > 1:
for mod in parts[:-1]:
mod_code = MODIFIERS.get(mod)
if mod_code is None:
raise KeyError("Invalid key modifier '{}'"
.format(mod_code))
modifier |= mod_code
if code not in codes:
codes[code] = []
codes[code].append(modifier)
self.codes = codes | Parse all the key codes and save them | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_key_event.py#L70-L89 |
frmdstryr/enamlx | enamlx/widgets/table_view.py | TableView._update_proxy | def _update_proxy(self, change):
""" An observer which sends state change to the proxy.
"""
if change['name'] == 'items':
self._update_visible_area()
super(TableView, self)._update_proxy(change) | python | def _update_proxy(self, change):
""" An observer which sends state change to the proxy.
"""
if change['name'] == 'items':
self._update_visible_area()
super(TableView, self)._update_proxy(change) | An observer which sends state change to the proxy. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/table_view.py#L63-L69 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin._setup_features | def _setup_features(self):
""" Setup the advanced widget feature handlers.
"""
features = self._features = self.declaration.features
if not features:
return
if features & Feature.FocusTraversal:
self.hook_focus_traversal()
if features & Feature.FocusEvents:
self.hook_focus_events()
if features & Feature.DragEnabled:
self.hook_drag()
if features & Feature.DropEnabled:
self.hook_drop()
features = self._extra_features
if features & GraphicFeature.WheelEvent:
self.hook_wheel()
if features & GraphicFeature.DrawEvent:
self.hook_draw() | python | def _setup_features(self):
""" Setup the advanced widget feature handlers.
"""
features = self._features = self.declaration.features
if not features:
return
if features & Feature.FocusTraversal:
self.hook_focus_traversal()
if features & Feature.FocusEvents:
self.hook_focus_events()
if features & Feature.DragEnabled:
self.hook_drag()
if features & Feature.DropEnabled:
self.hook_drop()
features = self._extra_features
if features & GraphicFeature.WheelEvent:
self.hook_wheel()
if features & GraphicFeature.DrawEvent:
self.hook_draw() | Setup the advanced widget feature handlers. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L158-L178 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin._teardown_features | def _teardown_features(self):
""" Teardowns the advanced widget feature handlers.
"""
features = self._features
if not features:
return
if features & Feature.FocusTraversal:
self.unhook_focus_traversal()
if features & Feature.FocusEvents:
self.unhook_focus_events()
if features & Feature.DragEnabled:
self.unhook_drag()
if features & Feature.DropEnabled:
self.unhook_drop()
features = self._extra_features
if features & GraphicFeature.WheelEvent:
self.unhook_wheel()
if features & GraphicFeature.DrawEvent:
self.unhook_draw() | python | def _teardown_features(self):
""" Teardowns the advanced widget feature handlers.
"""
features = self._features
if not features:
return
if features & Feature.FocusTraversal:
self.unhook_focus_traversal()
if features & Feature.FocusEvents:
self.unhook_focus_events()
if features & Feature.DragEnabled:
self.unhook_drag()
if features & Feature.DropEnabled:
self.unhook_drop()
features = self._extra_features
if features & GraphicFeature.WheelEvent:
self.unhook_wheel()
if features & GraphicFeature.DrawEvent:
self.unhook_draw() | Teardowns the advanced widget feature handlers. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L180-L200 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.tab_focus_request | def tab_focus_request(self, reason):
""" Handle a custom tab focus request.
This method is called when focus is being set on the proxy
as a result of a user-implemented focus traversal handler.
This can be reimplemented by subclasses as needed.
Parameters
----------
reason : Qt.FocusReason
The reason value for the focus request.
Returns
-------
result : bool
True if focus was set, False otherwise.
"""
widget = self.focus_target()
if not widget.focusPolicy & Qt.TabFocus:
return False
if not widget.isEnabled():
return False
if not widget.isVisibleTo(widget.window()):
return False
widget.setFocus(reason)
return False | python | def tab_focus_request(self, reason):
""" Handle a custom tab focus request.
This method is called when focus is being set on the proxy
as a result of a user-implemented focus traversal handler.
This can be reimplemented by subclasses as needed.
Parameters
----------
reason : Qt.FocusReason
The reason value for the focus request.
Returns
-------
result : bool
True if focus was set, False otherwise.
"""
widget = self.focus_target()
if not widget.focusPolicy & Qt.TabFocus:
return False
if not widget.isEnabled():
return False
if not widget.isVisibleTo(widget.window()):
return False
widget.setFocus(reason)
return False | Handle a custom tab focus request.
This method is called when focus is being set on the proxy
as a result of a user-implemented focus traversal handler.
This can be reimplemented by subclasses as needed.
Parameters
----------
reason : Qt.FocusReason
The reason value for the focus request.
Returns
-------
result : bool
True if focus was set, False otherwise. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L205-L231 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.hook_focus_events | def hook_focus_events(self):
""" Install the hooks for focus events.
This method may be overridden by subclasses as needed.
"""
widget = self.widget
widget.focusInEvent = self.focusInEvent
widget.focusOutEvent = self.focusOutEvent | python | def hook_focus_events(self):
""" Install the hooks for focus events.
This method may be overridden by subclasses as needed.
"""
widget = self.widget
widget.focusInEvent = self.focusInEvent
widget.focusOutEvent = self.focusOutEvent | Install the hooks for focus events.
This method may be overridden by subclasses as needed. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L258-L266 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.focusNextPrevChild | def focusNextPrevChild(self, next_child):
""" The default 'focusNextPrevChild' implementation.
"""
fd = focus_registry.focused_declaration()
if next_child:
child = self.declaration.next_focus_child(fd)
reason = Qt.TabFocusReason
else:
child = self.declaration.previous_focus_child(fd)
reason = Qt.BacktabFocusReason
if child is not None and child.proxy_is_active:
return child.proxy.tab_focus_request(reason)
widget = self.widget
return type(widget).focusNextPrevChild(widget, next_child) | python | def focusNextPrevChild(self, next_child):
""" The default 'focusNextPrevChild' implementation.
"""
fd = focus_registry.focused_declaration()
if next_child:
child = self.declaration.next_focus_child(fd)
reason = Qt.TabFocusReason
else:
child = self.declaration.previous_focus_child(fd)
reason = Qt.BacktabFocusReason
if child is not None and child.proxy_is_active:
return child.proxy.tab_focus_request(reason)
widget = self.widget
return type(widget).focusNextPrevChild(widget, next_child) | The default 'focusNextPrevChild' implementation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L278-L292 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.focusInEvent | def focusInEvent(self, event):
""" The default 'focusInEvent' implementation.
"""
widget = self.widget
type(widget).focusInEvent(widget, event)
self.declaration.focus_gained() | python | def focusInEvent(self, event):
""" The default 'focusInEvent' implementation.
"""
widget = self.widget
type(widget).focusInEvent(widget, event)
self.declaration.focus_gained() | The default 'focusInEvent' implementation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L294-L300 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.focusOutEvent | def focusOutEvent(self, event):
""" The default 'focusOutEvent' implementation.
"""
widget = self.widget
type(widget).focusOutEvent(widget, event)
self.declaration.focus_lost() | python | def focusOutEvent(self, event):
""" The default 'focusOutEvent' implementation.
"""
widget = self.widget
type(widget).focusOutEvent(widget, event)
self.declaration.focus_lost() | The default 'focusOutEvent' implementation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L302-L308 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.hook_drag | def hook_drag(self):
""" Install the hooks for drag operations.
"""
widget = self.widget
widget.mousePressEvent = self.mousePressEvent
widget.mouseMoveEvent = self.mouseMoveEvent
widget.mouseReleaseEvent = self.mouseReleaseEvent | python | def hook_drag(self):
""" Install the hooks for drag operations.
"""
widget = self.widget
widget.mousePressEvent = self.mousePressEvent
widget.mouseMoveEvent = self.mouseMoveEvent
widget.mouseReleaseEvent = self.mouseReleaseEvent | Install the hooks for drag operations. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L310-L317 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.unhook_drag | def unhook_drag(self):
""" Remove the hooks for drag operations.
"""
widget = self.widget
del widget.mousePressEvent
del widget.mouseMoveEvent
del widget.mouseReleaseEvent | python | def unhook_drag(self):
""" Remove the hooks for drag operations.
"""
widget = self.widget
del widget.mousePressEvent
del widget.mouseMoveEvent
del widget.mouseReleaseEvent | Remove the hooks for drag operations. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L319-L326 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.mousePressEvent | def mousePressEvent(self, event):
""" Handle the mouse press event for a drag operation.
"""
if event.button() == Qt.LeftButton:
self._drag_origin = event.pos()
widget = self.widget
type(widget).mousePressEvent(widget, event) | python | def mousePressEvent(self, event):
""" Handle the mouse press event for a drag operation.
"""
if event.button() == Qt.LeftButton:
self._drag_origin = event.pos()
widget = self.widget
type(widget).mousePressEvent(widget, event) | Handle the mouse press event for a drag operation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L328-L335 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.mouseMoveEvent | def mouseMoveEvent(self, event):
""" Handle the mouse move event for a drag operation.
"""
#if event.buttons() & Qt.LeftButton and self._drag_origin is not None:
#dist = (event.pos() - self._drag_origin).manhattanLength()
#if dist >= QApplication.startDragDistance():
#self.do_drag(event.widget())
#self._drag_origin = None
#return # Don't returns
widget = self.widget
type(widget).mouseMoveEvent(widget, event) | python | def mouseMoveEvent(self, event):
""" Handle the mouse move event for a drag operation.
"""
#if event.buttons() & Qt.LeftButton and self._drag_origin is not None:
#dist = (event.pos() - self._drag_origin).manhattanLength()
#if dist >= QApplication.startDragDistance():
#self.do_drag(event.widget())
#self._drag_origin = None
#return # Don't returns
widget = self.widget
type(widget).mouseMoveEvent(widget, event) | Handle the mouse move event for a drag operation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L337-L348 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.mouseReleaseEvent | def mouseReleaseEvent(self, event):
""" Handle the mouse release event for the drag operation.
"""
if event.button() == Qt.LeftButton:
self._drag_origin = None
widget = self.widget
type(widget).mouseReleaseEvent(widget, event) | python | def mouseReleaseEvent(self, event):
""" Handle the mouse release event for the drag operation.
"""
if event.button() == Qt.LeftButton:
self._drag_origin = None
widget = self.widget
type(widget).mouseReleaseEvent(widget, event) | Handle the mouse release event for the drag operation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L350-L357 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.hook_drop | def hook_drop(self):
""" Install hooks for drop operations.
"""
widget = self.widget
widget.setAcceptDrops(True)
widget.dragEnterEvent = self.dragEnterEvent
widget.dragMoveEvent = self.dragMoveEvent
widget.dragLeaveEvent = self.dragLeaveEvent
widget.dropEvent = self.dropEvent | python | def hook_drop(self):
""" Install hooks for drop operations.
"""
widget = self.widget
widget.setAcceptDrops(True)
widget.dragEnterEvent = self.dragEnterEvent
widget.dragMoveEvent = self.dragMoveEvent
widget.dragLeaveEvent = self.dragLeaveEvent
widget.dropEvent = self.dropEvent | Install hooks for drop operations. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L359-L368 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.unhook_drop | def unhook_drop(self):
""" Remove hooks for drop operations.
"""
widget = self.widget
widget.setAcceptDrops(False)
del widget.dragEnterEvent
del widget.dragMoveEvent
del widget.dragLeaveEvent
del widget.dropEvent | python | def unhook_drop(self):
""" Remove hooks for drop operations.
"""
widget = self.widget
widget.setAcceptDrops(False)
del widget.dragEnterEvent
del widget.dragMoveEvent
del widget.dragLeaveEvent
del widget.dropEvent | Remove hooks for drop operations. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L370-L379 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.do_drag | def do_drag(self, widget):
""" Perform the drag operation for the widget.
Parameters
----------
widget: QWidget
A reference to the viewport widget.
"""
drag_data = self.declaration.drag_start()
if drag_data is None:
return
#widget = self.widget
qdrag = QDrag(widget)
qdrag.setMimeData(drag_data.mime_data.q_data())
if drag_data.image is not None:
qimg = get_cached_qimage(drag_data.image)
qdrag.setPixmap(QPixmap.fromImage(qimg))
#else:
#if __version_info__ < (5, ):
#qdrag.setPixmap(QPixmap.grabWidget(self.widget))
#else:
#qdrag.setPixmap(widget.grab())
if drag_data.hotspot:
qdrag.setHotSpot(QPoint(*drag_data.hotspot))
else:
cursor_position = widget.mapFromGlobal(QCursor.pos())
qdrag.setHotSpot(cursor_position)
default = Qt.DropAction(drag_data.default_drop_action)
supported = Qt.DropActions(drag_data.supported_actions)
qresult = qdrag.exec_(supported, default)
self.declaration.drag_end(drag_data, DropAction(int(qresult))) | python | def do_drag(self, widget):
""" Perform the drag operation for the widget.
Parameters
----------
widget: QWidget
A reference to the viewport widget.
"""
drag_data = self.declaration.drag_start()
if drag_data is None:
return
#widget = self.widget
qdrag = QDrag(widget)
qdrag.setMimeData(drag_data.mime_data.q_data())
if drag_data.image is not None:
qimg = get_cached_qimage(drag_data.image)
qdrag.setPixmap(QPixmap.fromImage(qimg))
#else:
#if __version_info__ < (5, ):
#qdrag.setPixmap(QPixmap.grabWidget(self.widget))
#else:
#qdrag.setPixmap(widget.grab())
if drag_data.hotspot:
qdrag.setHotSpot(QPoint(*drag_data.hotspot))
else:
cursor_position = widget.mapFromGlobal(QCursor.pos())
qdrag.setHotSpot(cursor_position)
default = Qt.DropAction(drag_data.default_drop_action)
supported = Qt.DropActions(drag_data.supported_actions)
qresult = qdrag.exec_(supported, default)
self.declaration.drag_end(drag_data, DropAction(int(qresult))) | Perform the drag operation for the widget.
Parameters
----------
widget: QWidget
A reference to the viewport widget. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L381-L412 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.draw | def draw(self, painter, options, widget):
""" Handle the draw event for the widget.
"""
self.declaration.draw(painter, options, widget) | python | def draw(self, painter, options, widget):
""" Handle the draw event for the widget.
"""
self.declaration.draw(painter, options, widget) | Handle the draw event for the widget. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L477-L481 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | FeatureMixin.get_action | def get_action(self, create=False):
""" Get the shared widget action for this widget.
This API is used to support widgets in tool bars and menus.
Parameters
----------
create : bool, optional
Whether to create the action if it doesn't already exist.
The default is False.
Returns
-------
result : QWidgetAction or None
The cached widget action or None, depending on arguments.
"""
action = self._widget_action
if action is None and create:
action = self._widget_action = QWidgetAction(None)
action.setDefaultWidget(self.widget)
return action | python | def get_action(self, create=False):
""" Get the shared widget action for this widget.
This API is used to support widgets in tool bars and menus.
Parameters
----------
create : bool, optional
Whether to create the action if it doesn't already exist.
The default is False.
Returns
-------
result : QWidgetAction or None
The cached widget action or None, depending on arguments.
"""
action = self._widget_action
if action is None and create:
action = self._widget_action = QWidgetAction(None)
action.setDefaultWidget(self.widget)
return action | Get the shared widget action for this widget.
This API is used to support widgets in tool bars and menus.
Parameters
----------
create : bool, optional
Whether to create the action if it doesn't already exist.
The default is False.
Returns
-------
result : QWidgetAction or None
The cached widget action or None, depending on arguments. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L486-L507 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsView.mousePressEvent | def mousePressEvent(self, event):
""" Handle the mouse press event for a drag operation.
"""
self.declaration.mouse_press_event(event)
super(QtGraphicsView, self).mousePressEvent(event) | python | def mousePressEvent(self, event):
""" Handle the mouse press event for a drag operation.
"""
self.declaration.mouse_press_event(event)
super(QtGraphicsView, self).mousePressEvent(event) | Handle the mouse press event for a drag operation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L638-L643 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsView.mouseMoveEvent | def mouseMoveEvent(self, event):
""" Handle the mouse move event for a drag operation.
"""
self.declaration.mouse_move_event(event)
super(QtGraphicsView, self).mouseMoveEvent(event) | python | def mouseMoveEvent(self, event):
""" Handle the mouse move event for a drag operation.
"""
self.declaration.mouse_move_event(event)
super(QtGraphicsView, self).mouseMoveEvent(event) | Handle the mouse move event for a drag operation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L645-L650 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsView.mouseReleaseEvent | def mouseReleaseEvent(self, event):
""" Handle the mouse release event for the drag operation.
"""
self.declaration.mouse_release_event(event)
super(QtGraphicsView, self).mouseReleaseEvent(event) | python | def mouseReleaseEvent(self, event):
""" Handle the mouse release event for the drag operation.
"""
self.declaration.mouse_release_event(event)
super(QtGraphicsView, self).mouseReleaseEvent(event) | Handle the mouse release event for the drag operation. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L653-L658 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsView.set_renderer | def set_renderer(self, renderer):
""" Set the viewport widget.
"""
viewport = None
if renderer == 'opengl':
from enaml.qt.QtWidgets import QOpenGLWidget
viewport = QOpenGLWidget()
elif renderer == 'default':
try:
from enaml.qt.QtWidgets import QOpenGLWidget
viewport = QOpenGLWidget()
except ImportError as e:
warnings.warn(
"QOpenGLWidget could not be imported: {}".format(e))
self.widget.setViewport(viewport) | python | def set_renderer(self, renderer):
""" Set the viewport widget.
"""
viewport = None
if renderer == 'opengl':
from enaml.qt.QtWidgets import QOpenGLWidget
viewport = QOpenGLWidget()
elif renderer == 'default':
try:
from enaml.qt.QtWidgets import QOpenGLWidget
viewport = QOpenGLWidget()
except ImportError as e:
warnings.warn(
"QOpenGLWidget could not be imported: {}".format(e))
self.widget.setViewport(viewport) | Set the viewport widget. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L674-L689 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsView.on_selection_changed | def on_selection_changed(self):
""" Callback invoked one the selection has changed.
"""
d = self.declaration
selection = self.scene.selectedItems()
self._guards |= 0x01
try:
d.selected_items = [item.ref().declaration for item in selection
if item.ref()]
finally:
self._guards &= ~0x01 | python | def on_selection_changed(self):
""" Callback invoked one the selection has changed.
"""
d = self.declaration
selection = self.scene.selectedItems()
self._guards |= 0x01
try:
d.selected_items = [item.ref().declaration for item in selection
if item.ref()]
finally:
self._guards &= ~0x01 | Callback invoked one the selection has changed. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L698-L709 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsView.set_background | def set_background(self, background):
""" Set the background color of the widget.
"""
scene = self.scene
scene.setBackgroundBrush(QColor.fromRgba(background.argb)) | python | def set_background(self, background):
""" Set the background color of the widget.
"""
scene = self.scene
scene.setBackgroundBrush(QColor.fromRgba(background.argb)) | Set the background color of the widget. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L711-L716 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsView.scale_view | def scale_view(self, x, y):
""" Scale the zoom but keep in in the min and max zoom bounds.
"""
d = self.declaration
factor = self.widget.transform().scale(x, y).mapRect(
QRectF(0, 0, 1, 1)).width()
if (d.min_zoom > factor > d.max_zoom):
return
self.widget.scale(x, y)
return factor | python | def scale_view(self, x, y):
""" Scale the zoom but keep in in the min and max zoom bounds.
"""
d = self.declaration
factor = self.widget.transform().scale(x, y).mapRect(
QRectF(0, 0, 1, 1)).width()
if (d.min_zoom > factor > d.max_zoom):
return
self.widget.scale(x, y)
return factor | Scale the zoom but keep in in the min and max zoom bounds. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L748-L758 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsItem.destroy | def destroy(self):
""" Destroy the underlying QWidget object.
"""
self._teardown_features()
focus_registry.unregister(self.widget)
widget = self.widget
if widget is not None:
del self.widget
super(QtGraphicsItem, self).destroy()
# If a QWidgetAction was created for this widget, then it has
# taken ownership of the widget and the widget will be deleted
# when the QWidgetAction is garbage collected. This means the
# superclass destroy() method must run before the reference to
# the QWidgetAction is dropped.
del self._widget_action | python | def destroy(self):
""" Destroy the underlying QWidget object.
"""
self._teardown_features()
focus_registry.unregister(self.widget)
widget = self.widget
if widget is not None:
del self.widget
super(QtGraphicsItem, self).destroy()
# If a QWidgetAction was created for this widget, then it has
# taken ownership of the widget and the widget will be deleted
# when the QWidgetAction is garbage collected. This means the
# superclass destroy() method must run before the reference to
# the QWidgetAction is dropped.
del self._widget_action | Destroy the underlying QWidget object. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L830-L845 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsItem.parent_widget | def parent_widget(self):
""" Reimplemented to only return GraphicsItems """
parent = self.parent()
if parent is not None and isinstance(parent, QtGraphicsItem):
return parent.widget | python | def parent_widget(self):
""" Reimplemented to only return GraphicsItems """
parent = self.parent()
if parent is not None and isinstance(parent, QtGraphicsItem):
return parent.widget | Reimplemented to only return GraphicsItems | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L847-L851 |
frmdstryr/enamlx | enamlx/qt/qt_graphics_view.py | QtGraphicsWidget.init_layout | def init_layout(self):
""" Create the widget in the layout pass after the child widget has
been created and intialized. We do this so the child widget does not
attempt to use this proxy widget as its parent and because
repositioning must be done after the widget is set.
"""
self.widget = QGraphicsProxyWidget(self.parent_widget())
widget = self.widget
for item in self.child_widgets():
widget.setWidget(item)
break
super(QtGraphicsWidget, self).init_widget()
super(QtGraphicsWidget, self).init_layout() | python | def init_layout(self):
""" Create the widget in the layout pass after the child widget has
been created and intialized. We do this so the child widget does not
attempt to use this proxy widget as its parent and because
repositioning must be done after the widget is set.
"""
self.widget = QGraphicsProxyWidget(self.parent_widget())
widget = self.widget
for item in self.child_widgets():
widget.setWidget(item)
break
super(QtGraphicsWidget, self).init_widget()
super(QtGraphicsWidget, self).init_layout() | Create the widget in the layout pass after the child widget has
been created and intialized. We do this so the child widget does not
attempt to use this proxy widget as its parent and because
repositioning must be done after the widget is set. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_graphics_view.py#L937-L949 |
frmdstryr/enamlx | examples/occ_viewer/occ/occ_algo.py | OccOperation._dequeue_update | def _dequeue_update(self,change):
""" Only update when all changes are done """
self._update_count -=1
if self._update_count !=0:
return
self.update_shape(change) | python | def _dequeue_update(self,change):
""" Only update when all changes are done """
self._update_count -=1
if self._update_count !=0:
return
self.update_shape(change) | Only update when all changes are done | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/examples/occ_viewer/occ/occ_algo.py#L72-L77 |
frmdstryr/enamlx | examples/occ_viewer/occ/occ_algo.py | OccBooleanOperation.create_shape | def create_shape(self):
""" Create the toolkit shape for the proxy object.
This method is called during the top-down pass, just before the
'init_shape()' method is called. This method should create the
toolkit widget and assign it to the 'widget' attribute.
"""
d = self.declaration
if d.shape1 and d.shape2:
self.shape = self._do_operation(d.shape1, d.shape2)
else:
self.shape = None | python | def create_shape(self):
""" Create the toolkit shape for the proxy object.
This method is called during the top-down pass, just before the
'init_shape()' method is called. This method should create the
toolkit widget and assign it to the 'widget' attribute.
"""
d = self.declaration
if d.shape1 and d.shape2:
self.shape = self._do_operation(d.shape1, d.shape2)
else:
self.shape = None | Create the toolkit shape for the proxy object.
This method is called during the top-down pass, just before the
'init_shape()' method is called. This method should create the
toolkit widget and assign it to the 'widget' attribute. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/examples/occ_viewer/occ/occ_algo.py#L87-L99 |
frmdstryr/enamlx | enamlx/widgets/graphics_view.py | GraphicsItem.show | def show(self):
""" Ensure the widget is shown.
Calling this method will also set the widget visibility to True.
"""
self.visible = True
if self.proxy_is_active:
self.proxy.ensure_visible() | python | def show(self):
""" Ensure the widget is shown.
Calling this method will also set the widget visibility to True.
"""
self.visible = True
if self.proxy_is_active:
self.proxy.ensure_visible() | Ensure the widget is shown.
Calling this method will also set the widget visibility to True. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/graphics_view.py#L448-L454 |
frmdstryr/enamlx | enamlx/widgets/graphics_view.py | GraphicsItem.hide | def hide(self):
""" Ensure the widget is hidden.
Calling this method will also set the widget visibility to False.
"""
self.visible = False
if self.proxy_is_active:
self.proxy.ensure_hidden() | python | def hide(self):
""" Ensure the widget is hidden.
Calling this method will also set the widget visibility to False.
"""
self.visible = False
if self.proxy_is_active:
self.proxy.ensure_hidden() | Ensure the widget is hidden.
Calling this method will also set the widget visibility to False. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/graphics_view.py#L456-L462 |
frmdstryr/enamlx | enamlx/widgets/graphics_view.py | GraphicsView.get_item_at | def get_item_at(self, *args, **kwargs):
""" Return the items at the given position """
return self.proxy.get_item_at(coerce_point(*args, **kwargs)) | python | def get_item_at(self, *args, **kwargs):
""" Return the items at the given position """
return self.proxy.get_item_at(coerce_point(*args, **kwargs)) | Return the items at the given position | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/graphics_view.py#L795-L797 |
frmdstryr/enamlx | enamlx/widgets/graphics_view.py | GraphicsView.center_on | def center_on(self, item):
""" Center on the given item or point. """
if not isinstance(item, GraphicsItem):
item = coerce_point(item)
self.proxy.center_on(item) | python | def center_on(self, item):
""" Center on the given item or point. """
if not isinstance(item, GraphicsItem):
item = coerce_point(item)
self.proxy.center_on(item) | Center on the given item or point. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/graphics_view.py#L803-L807 |
frmdstryr/enamlx | enamlx/core/middleware.py | _custom_token_stream | def _custom_token_stream(self):
""" A wrapper for the BaseEnamlLexer's make_token_stream which allows
the stream to be customized by adding "token_stream_processors".
A token_stream_processor is a generator function which takes the
token_stream as it's single input argument and yields each processed token
as it's output. Each token will be an instance of `ply.lex.LexToken`.
"""
token_stream = default_make_token_stream(self)
for processor in _token_stream_processors:
token_stream = processor(token_stream)
return token_stream | python | def _custom_token_stream(self):
""" A wrapper for the BaseEnamlLexer's make_token_stream which allows
the stream to be customized by adding "token_stream_processors".
A token_stream_processor is a generator function which takes the
token_stream as it's single input argument and yields each processed token
as it's output. Each token will be an instance of `ply.lex.LexToken`.
"""
token_stream = default_make_token_stream(self)
for processor in _token_stream_processors:
token_stream = processor(token_stream)
return token_stream | A wrapper for the BaseEnamlLexer's make_token_stream which allows
the stream to be customized by adding "token_stream_processors".
A token_stream_processor is a generator function which takes the
token_stream as it's single input argument and yields each processed token
as it's output. Each token will be an instance of `ply.lex.LexToken`. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/core/middleware.py#L15-L27 |
frmdstryr/enamlx | enamlx/core/middleware.py | convert_enamldef_def_to_func | def convert_enamldef_def_to_func(token_stream):
""" A token stream processor which processes all enaml declarative functions
to allow using `def` instead of `func`. It does this by transforming DEF
tokens to NAME within enamldef blocks and then changing the token value to
`func`.
Notes
------
Use this at your own risk! This was a feature intentionally
dismissed by the author of enaml because declarative func's are not the
same as python functions.
"""
in_enamldef = False
depth = 0
for tok in token_stream:
if tok.type == 'ENAMLDEF':
in_enamldef = True
elif tok.type == 'INDENT':
depth += 1
elif in_enamldef and tok.type == 'DEF':
# Since functions are not allowed on the RHS we can
# transform the token type to a NAME so it's picked up by the
# parser as a decl_funcdef instead of funcdef
tok.type = 'NAME'
tok.value = 'func'
elif tok.type == 'DEDENT':
depth -= 1
if depth == 0:
in_enamldef = False
yield tok | python | def convert_enamldef_def_to_func(token_stream):
""" A token stream processor which processes all enaml declarative functions
to allow using `def` instead of `func`. It does this by transforming DEF
tokens to NAME within enamldef blocks and then changing the token value to
`func`.
Notes
------
Use this at your own risk! This was a feature intentionally
dismissed by the author of enaml because declarative func's are not the
same as python functions.
"""
in_enamldef = False
depth = 0
for tok in token_stream:
if tok.type == 'ENAMLDEF':
in_enamldef = True
elif tok.type == 'INDENT':
depth += 1
elif in_enamldef and tok.type == 'DEF':
# Since functions are not allowed on the RHS we can
# transform the token type to a NAME so it's picked up by the
# parser as a decl_funcdef instead of funcdef
tok.type = 'NAME'
tok.value = 'func'
elif tok.type == 'DEDENT':
depth -= 1
if depth == 0:
in_enamldef = False
yield tok | A token stream processor which processes all enaml declarative functions
to allow using `def` instead of `func`. It does this by transforming DEF
tokens to NAME within enamldef blocks and then changing the token value to
`func`.
Notes
------
Use this at your own risk! This was a feature intentionally
dismissed by the author of enaml because declarative func's are not the
same as python functions. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/core/middleware.py#L65-L95 |
frmdstryr/enamlx | enamlx/widgets/abstract_item_view.py | AbstractItemView.child_added | def child_added(self, child):
""" Reset the item cache when a child is added """
super(AbstractItemView, self).child_added(child)
self.get_member('_items').reset(self) | python | def child_added(self, child):
""" Reset the item cache when a child is added """
super(AbstractItemView, self).child_added(child)
self.get_member('_items').reset(self) | Reset the item cache when a child is added | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/abstract_item_view.py#L189-L192 |
frmdstryr/enamlx | enamlx/widgets/abstract_item_view.py | AbstractItemView.child_removed | def child_removed(self, child):
""" Reset the item cache when a child is removed """
super(AbstractItemView, self).child_removed(child)
self.get_member('_items').reset(self) | python | def child_removed(self, child):
""" Reset the item cache when a child is removed """
super(AbstractItemView, self).child_removed(child)
self.get_member('_items').reset(self) | Reset the item cache when a child is removed | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/abstract_item_view.py#L194-L197 |
frmdstryr/enamlx | enamlx/widgets/abstract_item.py | AbstractWidgetItemGroup.child_added | def child_added(self, child):
""" Reset the item cache when a child is added """
super(AbstractWidgetItemGroup, self).child_added(child)
self.get_member('_items').reset(self) | python | def child_added(self, child):
""" Reset the item cache when a child is added """
super(AbstractWidgetItemGroup, self).child_added(child)
self.get_member('_items').reset(self) | Reset the item cache when a child is added | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/abstract_item.py#L78-L81 |
frmdstryr/enamlx | enamlx/widgets/abstract_item.py | AbstractWidgetItemGroup.child_removed | def child_removed(self, child):
""" Reset the item cache when a child is removed """
super(AbstractWidgetItemGroup, self).child_removed(child)
self.get_member('_items').reset(self) | python | def child_removed(self, child):
""" Reset the item cache when a child is removed """
super(AbstractWidgetItemGroup, self).child_removed(child)
self.get_member('_items').reset(self) | Reset the item cache when a child is removed | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/abstract_item.py#L83-L86 |
frmdstryr/enamlx | enamlx/widgets/abstract_item.py | AbstractWidgetItem._update_proxy | def _update_proxy(self, change):
""" An observer which sends state change to the proxy.
"""
if change['name'] in ['row', 'column']:
super(AbstractWidgetItem, self)._update_proxy(change)
else:
self.proxy.data_changed(change) | python | def _update_proxy(self, change):
""" An observer which sends state change to the proxy.
"""
if change['name'] in ['row', 'column']:
super(AbstractWidgetItem, self)._update_proxy(change)
else:
self.proxy.data_changed(change) | An observer which sends state change to the proxy. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/abstract_item.py#L136-L142 |
frmdstryr/enamlx | enamlx/qt/qt_console.py | QtConsole.init_signal | def init_signal(self):
"""allow clean shutdown on sigint"""
signal.signal(signal.SIGINT, lambda sig, frame: self.exit(-2))
# need a timer, so that QApplication doesn't block until a real
# Qt event fires (can require mouse movement)
# timer trick from http://stackoverflow.com/q/4938723/938949
timer = QtCore.QTimer()
# Let the interpreter run each 200 ms:
timer.timeout.connect(lambda: None)
timer.start(200)
# hold onto ref, so the timer doesn't get cleaned up
self._sigint_timer = timer | python | def init_signal(self):
"""allow clean shutdown on sigint"""
signal.signal(signal.SIGINT, lambda sig, frame: self.exit(-2))
# need a timer, so that QApplication doesn't block until a real
# Qt event fires (can require mouse movement)
# timer trick from http://stackoverflow.com/q/4938723/938949
timer = QtCore.QTimer()
# Let the interpreter run each 200 ms:
timer.timeout.connect(lambda: None)
timer.start(200)
# hold onto ref, so the timer doesn't get cleaned up
self._sigint_timer = timer | allow clean shutdown on sigint | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_console.py#L84-L95 |
frmdstryr/enamlx | examples/occ_viewer/occ/shape.py | Shape._update_position | def _update_position(self, change):
""" Keep position in sync with x,y,z """
if change['type']!='update':
return
pt = gp_Pnt(self.x,self.y,self.z)
if not pt.IsEqual(self.position,self.tolerance):
self.position = pt | python | def _update_position(self, change):
""" Keep position in sync with x,y,z """
if change['type']!='update':
return
pt = gp_Pnt(self.x,self.y,self.z)
if not pt.IsEqual(self.position,self.tolerance):
self.position = pt | Keep position in sync with x,y,z | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/examples/occ_viewer/occ/shape.py#L229-L235 |
frmdstryr/enamlx | examples/occ_viewer/occ/shape.py | Shape._update_xyz | def _update_xyz(self, change):
""" Keep x,y,z in sync with position """
self.x,self.y,self.z = self.position.X(),self.position.Y(),self.position.Z() | python | def _update_xyz(self, change):
""" Keep x,y,z in sync with position """
self.x,self.y,self.z = self.position.X(),self.position.Y(),self.position.Z() | Keep x,y,z in sync with position | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/examples/occ_viewer/occ/shape.py#L238-L240 |
frmdstryr/enamlx | examples/occ_viewer/occ/shape.py | Shape._update_state | def _update_state(self, change):
""" Keep position and direction in sync with axis """
self._block_updates = True
try:
self.position = self.axis.Location()
self.direction = self.axis.Direction()
finally:
self._block_updates = False | python | def _update_state(self, change):
""" Keep position and direction in sync with axis """
self._block_updates = True
try:
self.position = self.axis.Location()
self.direction = self.axis.Direction()
finally:
self._block_updates = False | Keep position and direction in sync with axis | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/examples/occ_viewer/occ/shape.py#L249-L256 |
frmdstryr/enamlx | enamlx/qt/qt_plot_area.py | AbstractQtPlotItem._refresh_multi_axis | def _refresh_multi_axis(self):
""" If linked axis' are used, setup and link them """
d = self.declaration
#: Create a separate viewbox
self.viewbox = pg.ViewBox()
#: If this is the first nested plot, use the parent right axis
_plots = [c for c in self.parent().children() if isinstance(c,AbstractQtPlotItem)]
i = _plots.index(self)
if i==0:
self.axis = self.widget.getAxis('right')
self.widget.showAxis('right')
else:
self.axis = pg.AxisItem('right')
self.axis.setZValue(-10000)
#: Add new axis to scene
self.widget.layout.addItem(self.axis,2,i+2)
#: Link x axis to the parent axis
self.viewbox.setXLink(self.widget.vb)
#: Link y axis to the view
self.axis.linkToView(self.viewbox)
#: Set axis label
self.axis.setLabel(d.label_right)
#: Add Viewbox to parent scene
self.parent().parent_widget().scene().addItem(self.viewbox) | python | def _refresh_multi_axis(self):
""" If linked axis' are used, setup and link them """
d = self.declaration
#: Create a separate viewbox
self.viewbox = pg.ViewBox()
#: If this is the first nested plot, use the parent right axis
_plots = [c for c in self.parent().children() if isinstance(c,AbstractQtPlotItem)]
i = _plots.index(self)
if i==0:
self.axis = self.widget.getAxis('right')
self.widget.showAxis('right')
else:
self.axis = pg.AxisItem('right')
self.axis.setZValue(-10000)
#: Add new axis to scene
self.widget.layout.addItem(self.axis,2,i+2)
#: Link x axis to the parent axis
self.viewbox.setXLink(self.widget.vb)
#: Link y axis to the view
self.axis.linkToView(self.viewbox)
#: Set axis label
self.axis.setLabel(d.label_right)
#: Add Viewbox to parent scene
self.parent().parent_widget().scene().addItem(self.viewbox) | If linked axis' are used, setup and link them | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_plot_area.py#L174-L204 |
frmdstryr/enamlx | enamlx/qt/qt_plot_area.py | AbstractQtPlotItem.set_range_x | def set_range_x(self,val):
""" Set visible range of x data.
Note: Padding must be 0 or it will create an infinite loop
"""
d = self.declaration
if d.auto_range[0]:
return
self.widget.setXRange(*val,padding=0) | python | def set_range_x(self,val):
""" Set visible range of x data.
Note: Padding must be 0 or it will create an infinite loop
"""
d = self.declaration
if d.auto_range[0]:
return
self.widget.setXRange(*val,padding=0) | Set visible range of x data.
Note: Padding must be 0 or it will create an infinite loop | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_plot_area.py#L319-L328 |
frmdstryr/enamlx | enamlx/qt/qt_plot_area.py | AbstractQtPlotItem.set_range_y | def set_range_y(self,val):
""" Set visible range of y data.
Note: Padding must be 0 or it will create an infinite loop
"""
d = self.declaration
if d.auto_range[1]:
return
self.widget.setYRange(*val,padding=0) | python | def set_range_y(self,val):
""" Set visible range of y data.
Note: Padding must be 0 or it will create an infinite loop
"""
d = self.declaration
if d.auto_range[1]:
return
self.widget.setYRange(*val,padding=0) | Set visible range of y data.
Note: Padding must be 0 or it will create an infinite loop | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_plot_area.py#L330-L339 |
frmdstryr/enamlx | enamlx/qt/qt_plot_area.py | AbstractQtPlotItem.on_resized | def on_resized(self):
""" Update linked views """
d = self.declaration
if not self.is_root and d.parent.multi_axis:
if self.viewbox:
self.viewbox.setGeometry(self.widget.vb.sceneBoundingRect())
self.viewbox.linkedViewChanged(self.widget.vb,self.viewbox.XAxis) | python | def on_resized(self):
""" Update linked views """
d = self.declaration
if not self.is_root and d.parent.multi_axis:
if self.viewbox:
self.viewbox.setGeometry(self.widget.vb.sceneBoundingRect())
self.viewbox.linkedViewChanged(self.widget.vb,self.viewbox.XAxis) | Update linked views | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_plot_area.py#L352-L358 |
frmdstryr/enamlx | enamlx/widgets/tree_view.py | TreeViewItem._get_columns | def _get_columns(self):
""" List of child TreeViewColumns including
this item as the first column
"""
return [self] + [c for c in self.children
if isinstance(c, TreeViewColumn)] | python | def _get_columns(self):
""" List of child TreeViewColumns including
this item as the first column
"""
return [self] + [c for c in self.children
if isinstance(c, TreeViewColumn)] | List of child TreeViewColumns including
this item as the first column | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/tree_view.py#L90-L95 |
frmdstryr/enamlx | enamlx/widgets/tree_view.py | TreeViewItem._update_rows | def _update_rows(self):
""" Update the row and column numbers of child items. """
for row, item in enumerate(self._items):
item.row = row # Row is the Parent item
item.column = 0
for column, item in enumerate(self._columns):
item.row = self.row # Row is the Parent item
item.column = column | python | def _update_rows(self):
""" Update the row and column numbers of child items. """
for row, item in enumerate(self._items):
item.row = row # Row is the Parent item
item.column = 0
for column, item in enumerate(self._columns):
item.row = self.row # Row is the Parent item
item.column = column | Update the row and column numbers of child items. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/widgets/tree_view.py#L110-L118 |
frmdstryr/enamlx | enamlx/qt/qt_abstract_item_view.py | QAbstractAtomItemModel.setDeclaration | def setDeclaration(self, declaration):
""" Set the declaration this model will use for rendering
the the headers.
"""
assert isinstance(declaration.proxy, ProxyAbstractItemView), \
"The model declaration must be a QtAbstractItemView subclass. " \
"Got {]".format(declaration)
self.declaration = declaration | python | def setDeclaration(self, declaration):
""" Set the declaration this model will use for rendering
the the headers.
"""
assert isinstance(declaration.proxy, ProxyAbstractItemView), \
"The model declaration must be a QtAbstractItemView subclass. " \
"Got {]".format(declaration)
self.declaration = declaration | Set the declaration this model will use for rendering
the the headers. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_abstract_item_view.py#L42-L51 |
frmdstryr/enamlx | enamlx/qt/qt_abstract_item_view.py | QAbstractAtomItemModel.data | def data(self, index, role):
""" Retrieve the data for the item at the given index
"""
item = self.itemAt(index)
if not item:
return None
d = item.declaration
if role == Qt.DisplayRole:
return d.text
elif role == Qt.ToolTipRole:
return d.tool_tip
elif role == Qt.CheckStateRole and d.checkable:
return d.checked and Qt.Checked or Qt.Unchecked
elif role == Qt.DecorationRole and d.icon:
return get_cached_qicon(d.icon)
elif role == Qt.EditRole and d.editable:
return d.text
elif role == Qt.StatusTipRole:
return d.status_tip
elif role == Qt.TextAlignmentRole:
h, v = d.text_alignment
return TEXT_H_ALIGNMENTS[h] | TEXT_V_ALIGNMENTS[v]
elif role == Qt.ForegroundRole and d.foreground:
return get_cached_qcolor(d.foreground)
elif role == Qt.BackgroundRole and d.background:
return get_cached_qcolor(d.background)
#elif role == Qt.SizeHintRole and d.minimum_size:
# return d.minimum_size
return None | python | def data(self, index, role):
""" Retrieve the data for the item at the given index
"""
item = self.itemAt(index)
if not item:
return None
d = item.declaration
if role == Qt.DisplayRole:
return d.text
elif role == Qt.ToolTipRole:
return d.tool_tip
elif role == Qt.CheckStateRole and d.checkable:
return d.checked and Qt.Checked or Qt.Unchecked
elif role == Qt.DecorationRole and d.icon:
return get_cached_qicon(d.icon)
elif role == Qt.EditRole and d.editable:
return d.text
elif role == Qt.StatusTipRole:
return d.status_tip
elif role == Qt.TextAlignmentRole:
h, v = d.text_alignment
return TEXT_H_ALIGNMENTS[h] | TEXT_V_ALIGNMENTS[v]
elif role == Qt.ForegroundRole and d.foreground:
return get_cached_qcolor(d.foreground)
elif role == Qt.BackgroundRole and d.background:
return get_cached_qcolor(d.background)
#elif role == Qt.SizeHintRole and d.minimum_size:
# return d.minimum_size
return None | Retrieve the data for the item at the given index | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_abstract_item_view.py#L53-L82 |
frmdstryr/enamlx | enamlx/qt/qt_abstract_item_view.py | QAbstractAtomItemModel.setData | def setData(self, index, value, role=Qt.EditRole):
""" Set the data for the item at the given index to the given value.
"""
item = self.itemAt(index)
if not item:
return False
d = item.declaration
if role == Qt.CheckStateRole:
checked = value == Qt.Checked
if checked != d.checked:
d.checked = checked
d.toggled(checked)
return True
elif role == Qt.EditRole:
if value != d.text:
d.text = value
return True
return super(QAbstractAtomItemModel, self).setData(index, value, role) | python | def setData(self, index, value, role=Qt.EditRole):
""" Set the data for the item at the given index to the given value.
"""
item = self.itemAt(index)
if not item:
return False
d = item.declaration
if role == Qt.CheckStateRole:
checked = value == Qt.Checked
if checked != d.checked:
d.checked = checked
d.toggled(checked)
return True
elif role == Qt.EditRole:
if value != d.text:
d.text = value
return True
return super(QAbstractAtomItemModel, self).setData(index, value, role) | Set the data for the item at the given index to the given value. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_abstract_item_view.py#L109-L127 |
frmdstryr/enamlx | enamlx/qt/qt_abstract_item_view.py | QAbstractAtomItemModel.headerData | def headerData(self, index, orientation, role):
""" QHeaderView respects the following item data roles:
TextAlignmentRole,
DisplayRole,
FontRole,
DecorationRole,
ForegroundRole,
BackgroundRole.
"""
d = self.declaration
if orientation == Qt.Horizontal and role == Qt.DisplayRole:
try:
return d.horizontal_headers[index] \
if d.horizontal_headers else index
except IndexError:
return index
elif orientation == Qt.Vertical and role == Qt.DisplayRole:
try:
return d.vertical_headers[index] \
if d.vertical_headers else index
except IndexError:
return index
return None | python | def headerData(self, index, orientation, role):
""" QHeaderView respects the following item data roles:
TextAlignmentRole,
DisplayRole,
FontRole,
DecorationRole,
ForegroundRole,
BackgroundRole.
"""
d = self.declaration
if orientation == Qt.Horizontal and role == Qt.DisplayRole:
try:
return d.horizontal_headers[index] \
if d.horizontal_headers else index
except IndexError:
return index
elif orientation == Qt.Vertical and role == Qt.DisplayRole:
try:
return d.vertical_headers[index] \
if d.vertical_headers else index
except IndexError:
return index
return None | QHeaderView respects the following item data roles:
TextAlignmentRole,
DisplayRole,
FontRole,
DecorationRole,
ForegroundRole,
BackgroundRole. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_abstract_item_view.py#L129-L151 |
frmdstryr/enamlx | enamlx/qt/qt_abstract_item_view.py | QtAbstractItemView.init_signals | def init_signals(self):
""" Connect signals """
self.widget.activated.connect(self.on_item_activated)
self.widget.clicked.connect(self.on_item_clicked)
self.widget.doubleClicked.connect(self.on_item_double_clicked)
self.widget.entered.connect(self.on_item_entered)
self.widget.pressed.connect(self.on_item_pressed)
self.widget.customContextMenuRequested.connect(
self.on_custom_context_menu_requested)
self.selection_model = self.widget.selectionModel()
self.selection_model.selectionChanged.connect(
self.on_selection_changed)
self.widget.horizontalScrollBar().valueChanged.connect(
self.on_horizontal_scrollbar_moved)
self.widget.verticalScrollBar().valueChanged.connect(
self.on_vertical_scrollbar_moved) | python | def init_signals(self):
""" Connect signals """
self.widget.activated.connect(self.on_item_activated)
self.widget.clicked.connect(self.on_item_clicked)
self.widget.doubleClicked.connect(self.on_item_double_clicked)
self.widget.entered.connect(self.on_item_entered)
self.widget.pressed.connect(self.on_item_pressed)
self.widget.customContextMenuRequested.connect(
self.on_custom_context_menu_requested)
self.selection_model = self.widget.selectionModel()
self.selection_model.selectionChanged.connect(
self.on_selection_changed)
self.widget.horizontalScrollBar().valueChanged.connect(
self.on_horizontal_scrollbar_moved)
self.widget.verticalScrollBar().valueChanged.connect(
self.on_vertical_scrollbar_moved) | Connect signals | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_abstract_item_view.py#L211-L226 |
frmdstryr/enamlx | enamlx/qt/qt_abstract_item_view.py | QtAbstractItemView.set_items | def set_items(self, items):
""" Defer until later so the view is only updated after all items
are added.
"""
self._pending_view_refreshes +=1
timed_call(self._pending_timeout, self._refresh_layout) | python | def set_items(self, items):
""" Defer until later so the view is only updated after all items
are added.
"""
self._pending_view_refreshes +=1
timed_call(self._pending_timeout, self._refresh_layout) | Defer until later so the view is only updated after all items
are added. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_abstract_item_view.py#L274-L280 |
frmdstryr/enamlx | enamlx/qt/qt_abstract_item_view.py | QtAbstractItemView._refresh_layout | def _refresh_layout(self):
""" This queues and batches model changes so that the layout is only
refreshed after the `_pending_timeout` expires. This prevents
the UI from refreshing when inserting or removing a large number of
items until the operation is complete.
"""
self._pending_view_refreshes -= 1
if self._pending_view_refreshes == 0:
try:
self.model.layoutChanged.emit()
self.on_layout_refreshed()
except RuntimeError:
# View can be destroyed before we get here
return
self._refresh_sizes() | python | def _refresh_layout(self):
""" This queues and batches model changes so that the layout is only
refreshed after the `_pending_timeout` expires. This prevents
the UI from refreshing when inserting or removing a large number of
items until the operation is complete.
"""
self._pending_view_refreshes -= 1
if self._pending_view_refreshes == 0:
try:
self.model.layoutChanged.emit()
self.on_layout_refreshed()
except RuntimeError:
# View can be destroyed before we get here
return
self._refresh_sizes() | This queues and batches model changes so that the layout is only
refreshed after the `_pending_timeout` expires. This prevents
the UI from refreshing when inserting or removing a large number of
items until the operation is complete. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_abstract_item_view.py#L392-L407 |
frmdstryr/enamlx | enamlx/qt/qt_tree_view.py | QAtomTreeModel.index | def index(self, row, column, parent):
""" The index should point to the corresponding QtControl in the
enaml object hierarchy.
"""
item = parent.internalPointer()
#: If the parent is None
d = self.declaration if item is None else item.declaration
if row < len(d._items):
proxy = d._items[row].proxy
assert isinstance(proxy, QtTreeViewItem), \
"Invalid item {}".format(proxy)
else:
proxy = d.proxy
return self.createIndex(row, column, proxy) | python | def index(self, row, column, parent):
""" The index should point to the corresponding QtControl in the
enaml object hierarchy.
"""
item = parent.internalPointer()
#: If the parent is None
d = self.declaration if item is None else item.declaration
if row < len(d._items):
proxy = d._items[row].proxy
assert isinstance(proxy, QtTreeViewItem), \
"Invalid item {}".format(proxy)
else:
proxy = d.proxy
return self.createIndex(row, column, proxy) | The index should point to the corresponding QtControl in the
enaml object hierarchy. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_tree_view.py#L46-L59 |
frmdstryr/enamlx | enamlx/qt/qt_tree_view.py | QtTreeViewItem._default_view | def _default_view(self):
""" If this is the root item, return the parent
which must be a TreeView, otherwise return the
parent Item's view.
"""
parent = self.parent()
if isinstance(parent, QtTreeView):
return parent
return parent.view | python | def _default_view(self):
""" If this is the root item, return the parent
which must be a TreeView, otherwise return the
parent Item's view.
"""
parent = self.parent()
if isinstance(parent, QtTreeView):
return parent
return parent.view | If this is the root item, return the parent
which must be a TreeView, otherwise return the
parent Item's view. | https://github.com/frmdstryr/enamlx/blob/9582e29c88dc0c0340f912b49168b7307a47ed4f/enamlx/qt/qt_tree_view.py#L230-L238 |
LasLabs/python-five9 | five9/models/web_connector.py | WebConnector.search | def search(cls, five9, filters):
"""Search for a record on the remote and return the results.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result.
"""
return cls._name_search(five9.configuration.getWebConnectors, filters) | python | def search(cls, five9, filters):
"""Search for a record on the remote and return the results.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result.
"""
return cls._name_search(five9.configuration.getWebConnectors, filters) | Search for a record on the remote and return the results.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/web_connector.py#L146-L158 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel.read | def read(cls, five9, external_id):
"""Return a record singleton for the ID.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
external_id (mixed): The identified on Five9. This should be the
value that is in the ``__uid_field__`` field on the record.
Returns:
BaseModel: The record, if found. Otherwise ``None``
"""
results = cls.search(five9, {cls.__uid_field__: external_id})
if not results:
return None
return results[0] | python | def read(cls, five9, external_id):
"""Return a record singleton for the ID.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
external_id (mixed): The identified on Five9. This should be the
value that is in the ``__uid_field__`` field on the record.
Returns:
BaseModel: The record, if found. Otherwise ``None``
"""
results = cls.search(five9, {cls.__uid_field__: external_id})
if not results:
return None
return results[0] | Return a record singleton for the ID.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
external_id (mixed): The identified on Five9. This should be the
value that is in the ``__uid_field__`` field on the record.
Returns:
BaseModel: The record, if found. Otherwise ``None`` | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L55-L69 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel.update | def update(self, data):
"""Update the current memory record with the given data dict.
Args:
data (dict): Data dictionary to update the record attributes with.
"""
for key, value in data.items():
setattr(self, key, value) | python | def update(self, data):
"""Update the current memory record with the given data dict.
Args:
data (dict): Data dictionary to update the record attributes with.
"""
for key, value in data.items():
setattr(self, key, value) | Update the current memory record with the given data dict.
Args:
data (dict): Data dictionary to update the record attributes with. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L86-L93 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel._call_and_serialize | def _call_and_serialize(cls, method, data, refresh=False):
"""Call the remote method with data, and optionally refresh.
Args:
method (callable): The method on the Authenticated Five9 object
that should be called.
data (dict): A data dictionary that will be passed as the first
and only position argument to ``method``.
refresh (bool, optional): Set to ``True`` to get the record data
from Five9 before returning the record.
Returns:
BaseModel: The newly created record. If ``refresh`` is ``True``,
this will be fetched from Five9. Otherwise, it's the data
record that was sent to the server.
"""
method(data)
if refresh:
return cls.read(method.__self__, data[cls.__uid_field__])
else:
return cls.deserialize(cls._get_non_empty_dict(data)) | python | def _call_and_serialize(cls, method, data, refresh=False):
"""Call the remote method with data, and optionally refresh.
Args:
method (callable): The method on the Authenticated Five9 object
that should be called.
data (dict): A data dictionary that will be passed as the first
and only position argument to ``method``.
refresh (bool, optional): Set to ``True`` to get the record data
from Five9 before returning the record.
Returns:
BaseModel: The newly created record. If ``refresh`` is ``True``,
this will be fetched from Five9. Otherwise, it's the data
record that was sent to the server.
"""
method(data)
if refresh:
return cls.read(method.__self__, data[cls.__uid_field__])
else:
return cls.deserialize(cls._get_non_empty_dict(data)) | Call the remote method with data, and optionally refresh.
Args:
method (callable): The method on the Authenticated Five9 object
that should be called.
data (dict): A data dictionary that will be passed as the first
and only position argument to ``method``.
refresh (bool, optional): Set to ``True`` to get the record data
from Five9 before returning the record.
Returns:
BaseModel: The newly created record. If ``refresh`` is ``True``,
this will be fetched from Five9. Otherwise, it's the data
record that was sent to the server. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L104-L124 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel._get_name_filters | def _get_name_filters(cls, filters):
"""Return a regex filter for the UID column only."""
filters = filters.get(cls.__uid_field__)
if not filters:
filters = '.*'
elif not isinstance(filters, string_types):
filters = r'(%s)' % ('|'.join(filters))
return filters | python | def _get_name_filters(cls, filters):
"""Return a regex filter for the UID column only."""
filters = filters.get(cls.__uid_field__)
if not filters:
filters = '.*'
elif not isinstance(filters, string_types):
filters = r'(%s)' % ('|'.join(filters))
return filters | Return a regex filter for the UID column only. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L127-L134 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel._get_non_empty_dict | def _get_non_empty_dict(cls, mapping):
"""Return the mapping without any ``None`` values (recursive)."""
res = {}
for key, value in mapping.items():
if hasattr(value, 'items'):
value = cls._get_non_empty_dict(value)
elif isinstance(value, list):
value = cls._get_non_empty_list(value)
if value not in [[], {}, None]:
res[key] = value
return res | python | def _get_non_empty_dict(cls, mapping):
"""Return the mapping without any ``None`` values (recursive)."""
res = {}
for key, value in mapping.items():
if hasattr(value, 'items'):
value = cls._get_non_empty_dict(value)
elif isinstance(value, list):
value = cls._get_non_empty_list(value)
if value not in [[], {}, None]:
res[key] = value
return res | Return the mapping without any ``None`` values (recursive). | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L137-L147 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel._get_non_empty_list | def _get_non_empty_list(cls, iter):
"""Return a list of the input, excluding all ``None`` values."""
res = []
for value in iter:
if hasattr(value, 'items'):
value = cls._get_non_empty_dict(value) or None
if value is not None:
res.append(value)
return res | python | def _get_non_empty_list(cls, iter):
"""Return a list of the input, excluding all ``None`` values."""
res = []
for value in iter:
if hasattr(value, 'items'):
value = cls._get_non_empty_dict(value) or None
if value is not None:
res.append(value)
return res | Return a list of the input, excluding all ``None`` values. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L150-L158 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel._name_search | def _name_search(cls, method, filters):
"""Helper for search methods that use name filters.
Args:
method (callable): The Five9 API method to call with the name
filters.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result.
"""
filters = cls._get_name_filters(filters)
return [
cls.deserialize(cls._zeep_to_dict(row)) for row in method(filters)
] | python | def _name_search(cls, method, filters):
"""Helper for search methods that use name filters.
Args:
method (callable): The Five9 API method to call with the name
filters.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result.
"""
filters = cls._get_name_filters(filters)
return [
cls.deserialize(cls._zeep_to_dict(row)) for row in method(filters)
] | Helper for search methods that use name filters.
Args:
method (callable): The Five9 API method to call with the name
filters.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L161-L177 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel._zeep_to_dict | def _zeep_to_dict(cls, obj):
"""Convert a zeep object to a dictionary."""
res = serialize_object(obj)
res = cls._get_non_empty_dict(res)
return res | python | def _zeep_to_dict(cls, obj):
"""Convert a zeep object to a dictionary."""
res = serialize_object(obj)
res = cls._get_non_empty_dict(res)
return res | Convert a zeep object to a dictionary. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L180-L184 |
LasLabs/python-five9 | five9/models/base_model.py | BaseModel.__check_field | def __check_field(self, key):
"""Raises a KeyError if the field doesn't exist."""
if not self._props.get(key):
raise KeyError(
'The field "%s" does not exist on "%s"' % (
key, self.__class__.__name__,
),
) | python | def __check_field(self, key):
"""Raises a KeyError if the field doesn't exist."""
if not self._props.get(key):
raise KeyError(
'The field "%s" does not exist on "%s"' % (
key, self.__class__.__name__,
),
) | Raises a KeyError if the field doesn't exist. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/base_model.py#L206-L213 |
LasLabs/python-five9 | five9/five9.py | Five9.supervisor | def supervisor(self):
"""Return an authenticated connection for use, open new if required.
Returns:
SupervisorWebService: New or existing session with the Five9
Statistics API.
"""
supervisor = self._cached_client('supervisor')
if not self._api_supervisor_session:
self._api_supervisor_session = self.__create_supervisor_session(
supervisor,
)
return supervisor | python | def supervisor(self):
"""Return an authenticated connection for use, open new if required.
Returns:
SupervisorWebService: New or existing session with the Five9
Statistics API.
"""
supervisor = self._cached_client('supervisor')
if not self._api_supervisor_session:
self._api_supervisor_session = self.__create_supervisor_session(
supervisor,
)
return supervisor | Return an authenticated connection for use, open new if required.
Returns:
SupervisorWebService: New or existing session with the Five9
Statistics API. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/five9.py#L48-L60 |
LasLabs/python-five9 | five9/five9.py | Five9.create_mapping | def create_mapping(record, keys):
"""Create a field mapping for use in API updates and creates.
Args:
record (BaseModel): Record that should be mapped.
keys (list[str]): Fields that should be mapped as keys.
Returns:
dict: Dictionary with keys:
* ``field_mappings``: Field mappings as required by API.
* ``data``: Ordered data dictionary for input record.
"""
ordered = OrderedDict()
field_mappings = []
for key, value in record.items():
ordered[key] = value
field_mappings.append({
'columnNumber': len(ordered), # Five9 is not zero indexed.
'fieldName': key,
'key': key in keys,
})
return {
'field_mappings': field_mappings,
'data': ordered,
'fields': list(ordered.values()),
} | python | def create_mapping(record, keys):
"""Create a field mapping for use in API updates and creates.
Args:
record (BaseModel): Record that should be mapped.
keys (list[str]): Fields that should be mapped as keys.
Returns:
dict: Dictionary with keys:
* ``field_mappings``: Field mappings as required by API.
* ``data``: Ordered data dictionary for input record.
"""
ordered = OrderedDict()
field_mappings = []
for key, value in record.items():
ordered[key] = value
field_mappings.append({
'columnNumber': len(ordered), # Five9 is not zero indexed.
'fieldName': key,
'key': key in keys,
})
return {
'field_mappings': field_mappings,
'data': ordered,
'fields': list(ordered.values()),
} | Create a field mapping for use in API updates and creates.
Args:
record (BaseModel): Record that should be mapped.
keys (list[str]): Fields that should be mapped as keys.
Returns:
dict: Dictionary with keys:
* ``field_mappings``: Field mappings as required by API.
* ``data``: Ordered data dictionary for input record. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/five9.py#L68-L97 |
LasLabs/python-five9 | five9/five9.py | Five9.parse_response | def parse_response(fields, records):
"""Parse an API response into usable objects.
Args:
fields (list[str]): List of strings indicating the fields that
are represented in the records, in the order presented in
the records.::
[
'number1',
'number2',
'number3',
'first_name',
'last_name',
'company',
'street',
'city',
'state',
'zip',
]
records (list[dict]): A really crappy data structure representing
records as returned by Five9::
[
{
'values': {
'data': [
'8881234567',
None,
None,
'Dave',
'Lasley',
'LasLabs Inc',
None,
'Las Vegas',
'NV',
'89123',
]
}
}
]
Returns:
list[dict]: List of parsed records.
"""
data = [i['values']['data'] for i in records]
return [
{fields[idx]: row for idx, row in enumerate(d)}
for d in data
] | python | def parse_response(fields, records):
"""Parse an API response into usable objects.
Args:
fields (list[str]): List of strings indicating the fields that
are represented in the records, in the order presented in
the records.::
[
'number1',
'number2',
'number3',
'first_name',
'last_name',
'company',
'street',
'city',
'state',
'zip',
]
records (list[dict]): A really crappy data structure representing
records as returned by Five9::
[
{
'values': {
'data': [
'8881234567',
None,
None,
'Dave',
'Lasley',
'LasLabs Inc',
None,
'Las Vegas',
'NV',
'89123',
]
}
}
]
Returns:
list[dict]: List of parsed records.
"""
data = [i['values']['data'] for i in records]
return [
{fields[idx]: row for idx, row in enumerate(d)}
for d in data
] | Parse an API response into usable objects.
Args:
fields (list[str]): List of strings indicating the fields that
are represented in the records, in the order presented in
the records.::
[
'number1',
'number2',
'number3',
'first_name',
'last_name',
'company',
'street',
'city',
'state',
'zip',
]
records (list[dict]): A really crappy data structure representing
records as returned by Five9::
[
{
'values': {
'data': [
'8881234567',
None,
None,
'Dave',
'Lasley',
'LasLabs Inc',
None,
'Las Vegas',
'NV',
'89123',
]
}
}
]
Returns:
list[dict]: List of parsed records. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/five9.py#L100-L150 |
LasLabs/python-five9 | five9/five9.py | Five9.create_criteria | def create_criteria(cls, query):
"""Return a criteria from a dictionary containing a query.
Query should be a dictionary, keyed by field name. If the value is
a list, it will be divided into multiple criteria as required.
"""
criteria = []
for name, value in query.items():
if isinstance(value, list):
for inner_value in value:
criteria += cls.create_criteria({name: inner_value})
else:
criteria.append({
'criteria': {
'field': name,
'value': value,
},
})
return criteria or None | python | def create_criteria(cls, query):
"""Return a criteria from a dictionary containing a query.
Query should be a dictionary, keyed by field name. If the value is
a list, it will be divided into multiple criteria as required.
"""
criteria = []
for name, value in query.items():
if isinstance(value, list):
for inner_value in value:
criteria += cls.create_criteria({name: inner_value})
else:
criteria.append({
'criteria': {
'field': name,
'value': value,
},
})
return criteria or None | Return a criteria from a dictionary containing a query.
Query should be a dictionary, keyed by field name. If the value is
a list, it will be divided into multiple criteria as required. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/five9.py#L153-L171 |
LasLabs/python-five9 | five9/five9.py | Five9._get_authenticated_client | def _get_authenticated_client(self, wsdl):
"""Return an authenticated SOAP client.
Returns:
zeep.Client: Authenticated API client.
"""
return zeep.Client(
wsdl % quote(self.username),
transport=zeep.Transport(
session=self._get_authenticated_session(),
),
) | python | def _get_authenticated_client(self, wsdl):
"""Return an authenticated SOAP client.
Returns:
zeep.Client: Authenticated API client.
"""
return zeep.Client(
wsdl % quote(self.username),
transport=zeep.Transport(
session=self._get_authenticated_session(),
),
) | Return an authenticated SOAP client.
Returns:
zeep.Client: Authenticated API client. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/five9.py#L173-L184 |
LasLabs/python-five9 | five9/five9.py | Five9._get_authenticated_session | def _get_authenticated_session(self):
"""Return an authenticated requests session.
Returns:
requests.Session: Authenticated session for use.
"""
session = requests.Session()
session.auth = self.auth
return session | python | def _get_authenticated_session(self):
"""Return an authenticated requests session.
Returns:
requests.Session: Authenticated session for use.
"""
session = requests.Session()
session.auth = self.auth
return session | Return an authenticated requests session.
Returns:
requests.Session: Authenticated session for use. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/five9.py#L186-L194 |
LasLabs/python-five9 | five9/five9.py | Five9.__create_supervisor_session | def __create_supervisor_session(self, supervisor):
"""Create a new session on the supervisor service.
This is required in order to use most methods for the supervisor,
so it is called implicitly when generating a supervisor session.
"""
session_params = {
'forceLogoutSession': self.force_logout_session,
'rollingPeriod': self.rolling_period,
'statisticsRange': self.statistics_range,
'shiftStart': self.__to_milliseconds(
self.shift_start_hour,
),
'timeZone': self.__to_milliseconds(
self.time_zone_offset,
),
}
supervisor.setSessionParameters(session_params)
return session_params | python | def __create_supervisor_session(self, supervisor):
"""Create a new session on the supervisor service.
This is required in order to use most methods for the supervisor,
so it is called implicitly when generating a supervisor session.
"""
session_params = {
'forceLogoutSession': self.force_logout_session,
'rollingPeriod': self.rolling_period,
'statisticsRange': self.statistics_range,
'shiftStart': self.__to_milliseconds(
self.shift_start_hour,
),
'timeZone': self.__to_milliseconds(
self.time_zone_offset,
),
}
supervisor.setSessionParameters(session_params)
return session_params | Create a new session on the supervisor service.
This is required in order to use most methods for the supervisor,
so it is called implicitly when generating a supervisor session. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/five9.py#L204-L222 |
LasLabs/python-five9 | five9/environment.py | Api.model | def model(method):
"""Use this to decorate methods that expect a model."""
def wrapper(self, *args, **kwargs):
if self.__model__ is None:
raise ValidationError(
'You cannot perform CRUD operations without selecting a '
'model first.',
)
return method(self, *args, **kwargs)
return wrapper | python | def model(method):
"""Use this to decorate methods that expect a model."""
def wrapper(self, *args, **kwargs):
if self.__model__ is None:
raise ValidationError(
'You cannot perform CRUD operations without selecting a '
'model first.',
)
return method(self, *args, **kwargs)
return wrapper | Use this to decorate methods that expect a model. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/environment.py#L12-L21 |
LasLabs/python-five9 | five9/environment.py | Api.recordset | def recordset(method):
"""Use this to decorate methods that expect a record set."""
def wrapper(self, *args, **kwargs):
if self.__records__ is None:
raise ValidationError(
'There are no records in the set.',
)
return method(self, *args, **kwargs)
return Api.model(wrapper) | python | def recordset(method):
"""Use this to decorate methods that expect a record set."""
def wrapper(self, *args, **kwargs):
if self.__records__ is None:
raise ValidationError(
'There are no records in the set.',
)
return method(self, *args, **kwargs)
return Api.model(wrapper) | Use this to decorate methods that expect a record set. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/environment.py#L24-L32 |
LasLabs/python-five9 | five9/environment.py | Environment.create | def create(self, data, refresh=False):
"""Create the data on the remote, optionally refreshing."""
self.__model__.create(self.__five9__, data)
if refresh:
return self.read(data[self.__model__.__name__])
else:
return self.new(data) | python | def create(self, data, refresh=False):
"""Create the data on the remote, optionally refreshing."""
self.__model__.create(self.__five9__, data)
if refresh:
return self.read(data[self.__model__.__name__])
else:
return self.new(data) | Create the data on the remote, optionally refreshing. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/environment.py#L90-L96 |
LasLabs/python-five9 | five9/environment.py | Environment.new | def new(self, data):
"""Create a new memory record, but do not create on the remote."""
data = self.__model__._get_non_empty_dict(data)
return self.__class__(
self.__five9__,
self.__model__,
records=[self.__model__.deserialize(data)],
) | python | def new(self, data):
"""Create a new memory record, but do not create on the remote."""
data = self.__model__._get_non_empty_dict(data)
return self.__class__(
self.__five9__,
self.__model__,
records=[self.__model__.deserialize(data)],
) | Create a new memory record, but do not create on the remote. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/environment.py#L99-L106 |
LasLabs/python-five9 | five9/environment.py | Environment.search | def search(self, filters):
"""Search Five9 given a filter.
Args:
filters (dict): A dictionary of search strings, keyed by the name
of the field to search.
Returns:
Environment: An environment representing the recordset.
"""
records = self.__model__.search(self.__five9__, filters)
return self.__class__(
self.__five9__, self.__model__, records,
) | python | def search(self, filters):
"""Search Five9 given a filter.
Args:
filters (dict): A dictionary of search strings, keyed by the name
of the field to search.
Returns:
Environment: An environment representing the recordset.
"""
records = self.__model__.search(self.__five9__, filters)
return self.__class__(
self.__five9__, self.__model__, records,
) | Search Five9 given a filter.
Args:
filters (dict): A dictionary of search strings, keyed by the name
of the field to search.
Returns:
Environment: An environment representing the recordset. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/environment.py#L125-L138 |
LasLabs/python-five9 | five9/models/disposition.py | Disposition.create | def create(cls, five9, data, refresh=False):
"""Create a record on Five9.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
data (dict): A data dictionary that can be fed to ``deserialize``.
refresh (bool, optional): Set to ``True`` to get the record data
from Five9 before returning the record.
Returns:
BaseModel: The newly created record. If ``refresh`` is ``True``,
this will be fetched from Five9. Otherwise, it's the data
record that was sent to the server.
"""
return cls._call_and_serialize(
five9.configuration.createDisposition, data, refresh,
) | python | def create(cls, five9, data, refresh=False):
"""Create a record on Five9.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
data (dict): A data dictionary that can be fed to ``deserialize``.
refresh (bool, optional): Set to ``True`` to get the record data
from Five9 before returning the record.
Returns:
BaseModel: The newly created record. If ``refresh`` is ``True``,
this will be fetched from Five9. Otherwise, it's the data
record that was sent to the server.
"""
return cls._call_and_serialize(
five9.configuration.createDisposition, data, refresh,
) | Create a record on Five9.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
data (dict): A data dictionary that can be fed to ``deserialize``.
refresh (bool, optional): Set to ``True`` to get the record data
from Five9 before returning the record.
Returns:
BaseModel: The newly created record. If ``refresh`` is ``True``,
this will be fetched from Five9. Otherwise, it's the data
record that was sent to the server. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/disposition.py#L84-L100 |
LasLabs/python-five9 | five9/models/disposition.py | Disposition.search | def search(cls, five9, filters):
"""Search for a record on the remote and return the results.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result.
"""
return cls._name_search(five9.configuration.getDispositions, filters) | python | def search(cls, five9, filters):
"""Search for a record on the remote and return the results.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result.
"""
return cls._name_search(five9.configuration.getDispositions, filters) | Search for a record on the remote and return the results.
Args:
five9 (five9.Five9): The authenticated Five9 remote.
filters (dict): A dictionary of search parameters, keyed by the
name of the field to search. This should conform to the
schema defined in :func:`five9.Five9.create_criteria`.
Returns:
list[BaseModel]: A list of records representing the result. | https://github.com/LasLabs/python-five9/blob/ef53160d6658604524a2577391280d2b4501a7ce/five9/models/disposition.py#L103-L115 |
tonioo/sievelib | sievelib/managesieve.py | authentication_required | def authentication_required(meth):
"""Simple class method decorator.
Checks if the client is currently connected.
:param meth: the original called method
"""
def check(cls, *args, **kwargs):
if cls.authenticated:
return meth(cls, *args, **kwargs)
raise Error("Authentication required")
return check | python | def authentication_required(meth):
"""Simple class method decorator.
Checks if the client is currently connected.
:param meth: the original called method
"""
def check(cls, *args, **kwargs):
if cls.authenticated:
return meth(cls, *args, **kwargs)
raise Error("Authentication required")
return check | Simple class method decorator.
Checks if the client is currently connected.
:param meth: the original called method | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L58-L71 |
tonioo/sievelib | sievelib/managesieve.py | Client.__read_block | def __read_block(self, size):
"""Read a block of 'size' bytes from the server.
An internal buffer is used to read data from the server. If
enough data is available from it, we return that data.
Eventually, we try to grab the missing part from the server
for Client.read_timeout seconds. If no data can be
retrieved, it is considered as a fatal error and an 'Error'
exception is raised.
:param size: number of bytes to read
:rtype: string
:returns: the read block (can be empty)
"""
buf = b""
if len(self.__read_buffer):
limit = (
size if size <= len(self.__read_buffer) else
len(self.__read_buffer)
)
buf = self.__read_buffer[:limit]
self.__read_buffer = self.__read_buffer[limit:]
size -= limit
if not size:
return buf
try:
buf += self.sock.recv(size)
except (socket.timeout, ssl.SSLError):
raise Error("Failed to read %d bytes from the server" % size)
self.__dprint(buf)
return buf | python | def __read_block(self, size):
"""Read a block of 'size' bytes from the server.
An internal buffer is used to read data from the server. If
enough data is available from it, we return that data.
Eventually, we try to grab the missing part from the server
for Client.read_timeout seconds. If no data can be
retrieved, it is considered as a fatal error and an 'Error'
exception is raised.
:param size: number of bytes to read
:rtype: string
:returns: the read block (can be empty)
"""
buf = b""
if len(self.__read_buffer):
limit = (
size if size <= len(self.__read_buffer) else
len(self.__read_buffer)
)
buf = self.__read_buffer[:limit]
self.__read_buffer = self.__read_buffer[limit:]
size -= limit
if not size:
return buf
try:
buf += self.sock.recv(size)
except (socket.timeout, ssl.SSLError):
raise Error("Failed to read %d bytes from the server" % size)
self.__dprint(buf)
return buf | Read a block of 'size' bytes from the server.
An internal buffer is used to read data from the server. If
enough data is available from it, we return that data.
Eventually, we try to grab the missing part from the server
for Client.read_timeout seconds. If no data can be
retrieved, it is considered as a fatal error and an 'Error'
exception is raised.
:param size: number of bytes to read
:rtype: string
:returns: the read block (can be empty) | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L103-L134 |
tonioo/sievelib | sievelib/managesieve.py | Client.__read_line | def __read_line(self):
"""Read one line from the server.
An internal buffer is used to read data from the server
(blocks of Client.read_size bytes). If the buffer
is not empty, we try to find an entire line to return.
If we failed, we try to read new content from the server for
Client.read_timeout seconds. If no data can be
retrieved, it is considered as a fatal error and an 'Error'
exception is raised.
:rtype: string
:return: the read line
"""
ret = b""
while True:
try:
pos = self.__read_buffer.index(CRLF)
ret = self.__read_buffer[:pos]
self.__read_buffer = self.__read_buffer[pos + len(CRLF):]
break
except ValueError:
pass
try:
nval = self.sock.recv(self.read_size)
self.__dprint(nval)
if not len(nval):
break
self.__read_buffer += nval
except (socket.timeout, ssl.SSLError):
raise Error("Failed to read data from the server")
if len(ret):
m = self.__size_expr.match(ret)
if m:
raise Literal(int(m.group(1)))
m = self.__respcode_expr.match(ret)
if m:
if m.group(1) == b"BYE":
raise Error("Connection closed by server")
if m.group(1) == b"NO":
self.__parse_error(m.group(2))
raise Response(m.group(1), m.group(2))
return ret | python | def __read_line(self):
"""Read one line from the server.
An internal buffer is used to read data from the server
(blocks of Client.read_size bytes). If the buffer
is not empty, we try to find an entire line to return.
If we failed, we try to read new content from the server for
Client.read_timeout seconds. If no data can be
retrieved, it is considered as a fatal error and an 'Error'
exception is raised.
:rtype: string
:return: the read line
"""
ret = b""
while True:
try:
pos = self.__read_buffer.index(CRLF)
ret = self.__read_buffer[:pos]
self.__read_buffer = self.__read_buffer[pos + len(CRLF):]
break
except ValueError:
pass
try:
nval = self.sock.recv(self.read_size)
self.__dprint(nval)
if not len(nval):
break
self.__read_buffer += nval
except (socket.timeout, ssl.SSLError):
raise Error("Failed to read data from the server")
if len(ret):
m = self.__size_expr.match(ret)
if m:
raise Literal(int(m.group(1)))
m = self.__respcode_expr.match(ret)
if m:
if m.group(1) == b"BYE":
raise Error("Connection closed by server")
if m.group(1) == b"NO":
self.__parse_error(m.group(2))
raise Response(m.group(1), m.group(2))
return ret | Read one line from the server.
An internal buffer is used to read data from the server
(blocks of Client.read_size bytes). If the buffer
is not empty, we try to find an entire line to return.
If we failed, we try to read new content from the server for
Client.read_timeout seconds. If no data can be
retrieved, it is considered as a fatal error and an 'Error'
exception is raised.
:rtype: string
:return: the read line | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L136-L181 |
tonioo/sievelib | sievelib/managesieve.py | Client.__read_response | def __read_response(self, nblines=-1):
"""Read a response from the server.
In the usual case, we read lines until we find one that looks
like a response (OK|NO|BYE\s*(.+)?).
If *nblines* > 0, we read excactly nblines before returning.
:param nblines: number of lines to read (default : -1)
:rtype: tuple
:return: a tuple of the form (code, data, response). If
nblines is provided, code and data can be equal to None.
"""
resp, code, data = (b"", None, None)
cpt = 0
while True:
try:
line = self.__read_line()
except Response as inst:
code = inst.code
data = inst.data
break
except Literal as inst:
resp += self.__read_block(inst.value)
if not resp.endswith(CRLF):
resp += self.__read_line() + CRLF
continue
if not len(line):
continue
resp += line + CRLF
cpt += 1
if nblines != -1 and cpt == nblines:
break
return (code, data, resp) | python | def __read_response(self, nblines=-1):
"""Read a response from the server.
In the usual case, we read lines until we find one that looks
like a response (OK|NO|BYE\s*(.+)?).
If *nblines* > 0, we read excactly nblines before returning.
:param nblines: number of lines to read (default : -1)
:rtype: tuple
:return: a tuple of the form (code, data, response). If
nblines is provided, code and data can be equal to None.
"""
resp, code, data = (b"", None, None)
cpt = 0
while True:
try:
line = self.__read_line()
except Response as inst:
code = inst.code
data = inst.data
break
except Literal as inst:
resp += self.__read_block(inst.value)
if not resp.endswith(CRLF):
resp += self.__read_line() + CRLF
continue
if not len(line):
continue
resp += line + CRLF
cpt += 1
if nblines != -1 and cpt == nblines:
break
return (code, data, resp) | Read a response from the server.
In the usual case, we read lines until we find one that looks
like a response (OK|NO|BYE\s*(.+)?).
If *nblines* > 0, we read excactly nblines before returning.
:param nblines: number of lines to read (default : -1)
:rtype: tuple
:return: a tuple of the form (code, data, response). If
nblines is provided, code and data can be equal to None. | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L183-L217 |
tonioo/sievelib | sievelib/managesieve.py | Client.__prepare_args | def __prepare_args(self, args):
"""Format command arguments before sending them.
Command arguments of type string must be quoted, the only
exception concerns size indication (of the form {\d\+?}).
:param args: list of arguments
:return: a list for transformed arguments
"""
ret = []
for a in args:
if isinstance(a, six.binary_type):
if self.__size_expr.match(a):
ret += [a]
else:
ret += [b'"' + a + b'"']
continue
ret += [bytes(str(a).encode("utf-8"))]
return ret | python | def __prepare_args(self, args):
"""Format command arguments before sending them.
Command arguments of type string must be quoted, the only
exception concerns size indication (of the form {\d\+?}).
:param args: list of arguments
:return: a list for transformed arguments
"""
ret = []
for a in args:
if isinstance(a, six.binary_type):
if self.__size_expr.match(a):
ret += [a]
else:
ret += [b'"' + a + b'"']
continue
ret += [bytes(str(a).encode("utf-8"))]
return ret | Format command arguments before sending them.
Command arguments of type string must be quoted, the only
exception concerns size indication (of the form {\d\+?}).
:param args: list of arguments
:return: a list for transformed arguments | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L219-L237 |
tonioo/sievelib | sievelib/managesieve.py | Client.__send_command | def __send_command(
self, name, args=None, withcontent=False, extralines=None,
nblines=-1):
"""Send a command to the server.
If args is not empty, we concatenate the given command with
the content of this list. If extralines is not empty, they are
sent one by one to the server. (CLRF are automatically
appended to them)
We wait for a response just after the command has been sent.
:param name: the command to sent
:param args: a list of arguments for this command
:param withcontent: tells the function to return the server's response
or not
:param extralines: a list of extra lines to sent after the command
:param nblines: the number of response lines to read (all by default)
:returns: a tuple of the form (code, data[, response])
"""
tosend = name.encode("utf-8")
if args:
tosend += b" " + b" ".join(self.__prepare_args(args))
self.__dprint(b"Command: " + tosend)
self.sock.sendall(tosend + CRLF)
if extralines:
for l in extralines:
self.sock.sendall(l + CRLF)
code, data, content = self.__read_response(nblines)
if isinstance(code, six.binary_type):
code = code.decode("utf-8")
if isinstance(data, six.binary_type):
data = data.decode("utf-8")
if withcontent:
return (code, data, content)
return (code, data) | python | def __send_command(
self, name, args=None, withcontent=False, extralines=None,
nblines=-1):
"""Send a command to the server.
If args is not empty, we concatenate the given command with
the content of this list. If extralines is not empty, they are
sent one by one to the server. (CLRF are automatically
appended to them)
We wait for a response just after the command has been sent.
:param name: the command to sent
:param args: a list of arguments for this command
:param withcontent: tells the function to return the server's response
or not
:param extralines: a list of extra lines to sent after the command
:param nblines: the number of response lines to read (all by default)
:returns: a tuple of the form (code, data[, response])
"""
tosend = name.encode("utf-8")
if args:
tosend += b" " + b" ".join(self.__prepare_args(args))
self.__dprint(b"Command: " + tosend)
self.sock.sendall(tosend + CRLF)
if extralines:
for l in extralines:
self.sock.sendall(l + CRLF)
code, data, content = self.__read_response(nblines)
if isinstance(code, six.binary_type):
code = code.decode("utf-8")
if isinstance(data, six.binary_type):
data = data.decode("utf-8")
if withcontent:
return (code, data, content)
return (code, data) | Send a command to the server.
If args is not empty, we concatenate the given command with
the content of this list. If extralines is not empty, they are
sent one by one to the server. (CLRF are automatically
appended to them)
We wait for a response just after the command has been sent.
:param name: the command to sent
:param args: a list of arguments for this command
:param withcontent: tells the function to return the server's response
or not
:param extralines: a list of extra lines to sent after the command
:param nblines: the number of response lines to read (all by default)
:returns: a tuple of the form (code, data[, response]) | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L239-L278 |
tonioo/sievelib | sievelib/managesieve.py | Client.__parse_error | def __parse_error(self, text):
"""Parse an error received from the server.
if text corresponds to a size indication, we grab the
remaining content from the server.
Otherwise, we try to match an error of the form \(\w+\)?\s*".+"
On succes, the two public members errcode and errmsg are
filled with the parsing results.
:param text: the response to parse
"""
m = self.__size_expr.match(text)
if m is not None:
self.errcode = b""
self.errmsg = self.__read_block(int(m.group(1)) + 2)
return
m = self.__error_expr.match(text)
if m is None:
raise Error("Bad error message")
if m.group(1) is not None:
self.errcode = m.group(1).strip(b"()")
else:
self.errcode = b""
self.errmsg = m.group(2).strip(b'"') | python | def __parse_error(self, text):
"""Parse an error received from the server.
if text corresponds to a size indication, we grab the
remaining content from the server.
Otherwise, we try to match an error of the form \(\w+\)?\s*".+"
On succes, the two public members errcode and errmsg are
filled with the parsing results.
:param text: the response to parse
"""
m = self.__size_expr.match(text)
if m is not None:
self.errcode = b""
self.errmsg = self.__read_block(int(m.group(1)) + 2)
return
m = self.__error_expr.match(text)
if m is None:
raise Error("Bad error message")
if m.group(1) is not None:
self.errcode = m.group(1).strip(b"()")
else:
self.errcode = b""
self.errmsg = m.group(2).strip(b'"') | Parse an error received from the server.
if text corresponds to a size indication, we grab the
remaining content from the server.
Otherwise, we try to match an error of the form \(\w+\)?\s*".+"
On succes, the two public members errcode and errmsg are
filled with the parsing results.
:param text: the response to parse | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L296-L322 |
tonioo/sievelib | sievelib/managesieve.py | Client._plain_authentication | def _plain_authentication(self, login, password, authz_id=b""):
"""SASL PLAIN authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise.
"""
if isinstance(login, six.text_type):
login = login.encode("utf-8")
if isinstance(password, six.text_type):
password = password.encode("utf-8")
params = base64.b64encode(b'\0'.join([authz_id, login, password]))
code, data = self.__send_command("AUTHENTICATE", [b"PLAIN", params])
if code == "OK":
return True
return False | python | def _plain_authentication(self, login, password, authz_id=b""):
"""SASL PLAIN authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise.
"""
if isinstance(login, six.text_type):
login = login.encode("utf-8")
if isinstance(password, six.text_type):
password = password.encode("utf-8")
params = base64.b64encode(b'\0'.join([authz_id, login, password]))
code, data = self.__send_command("AUTHENTICATE", [b"PLAIN", params])
if code == "OK":
return True
return False | SASL PLAIN authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise. | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L324-L339 |
tonioo/sievelib | sievelib/managesieve.py | Client._login_authentication | def _login_authentication(self, login, password, authz_id=""):
"""SASL LOGIN authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise.
"""
extralines = [b'"%s"' % base64.b64encode(login.encode("utf-8")),
b'"%s"' % base64.b64encode(password.encode("utf-8"))]
code, data = self.__send_command("AUTHENTICATE", [b"LOGIN"],
extralines=extralines)
if code == "OK":
return True
return False | python | def _login_authentication(self, login, password, authz_id=""):
"""SASL LOGIN authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise.
"""
extralines = [b'"%s"' % base64.b64encode(login.encode("utf-8")),
b'"%s"' % base64.b64encode(password.encode("utf-8"))]
code, data = self.__send_command("AUTHENTICATE", [b"LOGIN"],
extralines=extralines)
if code == "OK":
return True
return False | SASL LOGIN authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise. | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L341-L354 |
tonioo/sievelib | sievelib/managesieve.py | Client._digest_md5_authentication | def _digest_md5_authentication(self, login, password, authz_id=""):
"""SASL DIGEST-MD5 authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise.
"""
code, data, challenge = \
self.__send_command("AUTHENTICATE", [b"DIGEST-MD5"],
withcontent=True, nblines=1)
dmd5 = DigestMD5(challenge, "sieve/%s" % self.srvaddr)
code, data, challenge = self.__send_command(
'"%s"' % dmd5.response(login, password, authz_id),
withcontent=True, nblines=1
)
if not challenge:
return False
if not dmd5.check_last_challenge(login, password, challenge):
self.errmsg = "Bad challenge received from server"
return False
code, data = self.__send_command('""')
if code == "OK":
return True
return False | python | def _digest_md5_authentication(self, login, password, authz_id=""):
"""SASL DIGEST-MD5 authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise.
"""
code, data, challenge = \
self.__send_command("AUTHENTICATE", [b"DIGEST-MD5"],
withcontent=True, nblines=1)
dmd5 = DigestMD5(challenge, "sieve/%s" % self.srvaddr)
code, data, challenge = self.__send_command(
'"%s"' % dmd5.response(login, password, authz_id),
withcontent=True, nblines=1
)
if not challenge:
return False
if not dmd5.check_last_challenge(login, password, challenge):
self.errmsg = "Bad challenge received from server"
return False
code, data = self.__send_command('""')
if code == "OK":
return True
return False | SASL DIGEST-MD5 authentication
:param login: username
:param password: clear password
:return: True on success, False otherwise. | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L356-L380 |
tonioo/sievelib | sievelib/managesieve.py | Client.__authenticate | def __authenticate(self, login, password, authz_id=b"", authmech=None):
"""AUTHENTICATE command
Actually, it is just a wrapper to the real commands (one by
mechanism). We try all supported mechanisms (from the
strongest to the weakest) until we find one supported by the
server.
Then we try to authenticate (only once).
:param login: username
:param password: clear password
:param authz_id: authorization ID
:param authmech: prefered authentication mechanism
:return: True on success, False otherwise
"""
if "SASL" not in self.__capabilities:
raise Error("SASL not supported by the server")
srv_mechanisms = self.get_sasl_mechanisms()
if authmech is None or authmech not in SUPPORTED_AUTH_MECHS:
mech_list = SUPPORTED_AUTH_MECHS
else:
mech_list = [authmech]
for mech in mech_list:
if mech not in srv_mechanisms:
continue
mech = mech.lower().replace("-", "_")
auth_method = getattr(self, "_%s_authentication" % mech)
if auth_method(login, password, authz_id):
self.authenticated = True
return True
return False
self.errmsg = b"No suitable mechanism found"
return False | python | def __authenticate(self, login, password, authz_id=b"", authmech=None):
"""AUTHENTICATE command
Actually, it is just a wrapper to the real commands (one by
mechanism). We try all supported mechanisms (from the
strongest to the weakest) until we find one supported by the
server.
Then we try to authenticate (only once).
:param login: username
:param password: clear password
:param authz_id: authorization ID
:param authmech: prefered authentication mechanism
:return: True on success, False otherwise
"""
if "SASL" not in self.__capabilities:
raise Error("SASL not supported by the server")
srv_mechanisms = self.get_sasl_mechanisms()
if authmech is None or authmech not in SUPPORTED_AUTH_MECHS:
mech_list = SUPPORTED_AUTH_MECHS
else:
mech_list = [authmech]
for mech in mech_list:
if mech not in srv_mechanisms:
continue
mech = mech.lower().replace("-", "_")
auth_method = getattr(self, "_%s_authentication" % mech)
if auth_method(login, password, authz_id):
self.authenticated = True
return True
return False
self.errmsg = b"No suitable mechanism found"
return False | AUTHENTICATE command
Actually, it is just a wrapper to the real commands (one by
mechanism). We try all supported mechanisms (from the
strongest to the weakest) until we find one supported by the
server.
Then we try to authenticate (only once).
:param login: username
:param password: clear password
:param authz_id: authorization ID
:param authmech: prefered authentication mechanism
:return: True on success, False otherwise | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L382-L418 |
tonioo/sievelib | sievelib/managesieve.py | Client.__starttls | def __starttls(self, keyfile=None, certfile=None):
"""STARTTLS command
See MANAGESIEVE specifications, section 2.2.
:param keyfile: an eventual private key to use
:param certfile: an eventual certificate to use
:rtype: boolean
"""
if not self.has_tls_support():
raise Error("STARTTLS not supported by the server")
code, data = self.__send_command("STARTTLS")
if code != "OK":
return False
try:
nsock = ssl.wrap_socket(self.sock, keyfile, certfile)
except ssl.SSLError as e:
raise Error("SSL error: %s" % str(e))
self.sock = nsock
self.__capabilities = {}
self.__get_capabilities()
return True | python | def __starttls(self, keyfile=None, certfile=None):
"""STARTTLS command
See MANAGESIEVE specifications, section 2.2.
:param keyfile: an eventual private key to use
:param certfile: an eventual certificate to use
:rtype: boolean
"""
if not self.has_tls_support():
raise Error("STARTTLS not supported by the server")
code, data = self.__send_command("STARTTLS")
if code != "OK":
return False
try:
nsock = ssl.wrap_socket(self.sock, keyfile, certfile)
except ssl.SSLError as e:
raise Error("SSL error: %s" % str(e))
self.sock = nsock
self.__capabilities = {}
self.__get_capabilities()
return True | STARTTLS command
See MANAGESIEVE specifications, section 2.2.
:param keyfile: an eventual private key to use
:param certfile: an eventual certificate to use
:rtype: boolean | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L420-L441 |
tonioo/sievelib | sievelib/managesieve.py | Client.get_sieve_capabilities | def get_sieve_capabilities(self):
"""Returns the SIEVE extensions supported by the server.
They're read from server capabilities. (see the CAPABILITY
command)
:rtype: string
"""
if isinstance(self.__capabilities["SIEVE"], six.string_types):
self.__capabilities["SIEVE"] = self.__capabilities["SIEVE"].split()
return self.__capabilities["SIEVE"] | python | def get_sieve_capabilities(self):
"""Returns the SIEVE extensions supported by the server.
They're read from server capabilities. (see the CAPABILITY
command)
:rtype: string
"""
if isinstance(self.__capabilities["SIEVE"], six.string_types):
self.__capabilities["SIEVE"] = self.__capabilities["SIEVE"].split()
return self.__capabilities["SIEVE"] | Returns the SIEVE extensions supported by the server.
They're read from server capabilities. (see the CAPABILITY
command)
:rtype: string | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L473-L483 |
tonioo/sievelib | sievelib/managesieve.py | Client.connect | def connect(
self, login, password, authz_id=b"", starttls=False,
authmech=None):
"""Establish a connection with the server.
This function must be used. It read the server capabilities
and wraps calls to STARTTLS and AUTHENTICATE commands.
:param login: username
:param password: clear password
:param starttls: use a TLS connection or not
:param authmech: prefered authenticate mechanism
:rtype: boolean
"""
try:
self.sock = socket.create_connection((self.srvaddr, self.srvport))
self.sock.settimeout(Client.read_timeout)
except socket.error as msg:
raise Error("Connection to server failed: %s" % str(msg))
if not self.__get_capabilities():
raise Error("Failed to read capabilities from server")
if starttls and not self.__starttls():
return False
if self.__authenticate(login, password, authz_id, authmech):
return True
return False | python | def connect(
self, login, password, authz_id=b"", starttls=False,
authmech=None):
"""Establish a connection with the server.
This function must be used. It read the server capabilities
and wraps calls to STARTTLS and AUTHENTICATE commands.
:param login: username
:param password: clear password
:param starttls: use a TLS connection or not
:param authmech: prefered authenticate mechanism
:rtype: boolean
"""
try:
self.sock = socket.create_connection((self.srvaddr, self.srvport))
self.sock.settimeout(Client.read_timeout)
except socket.error as msg:
raise Error("Connection to server failed: %s" % str(msg))
if not self.__get_capabilities():
raise Error("Failed to read capabilities from server")
if starttls and not self.__starttls():
return False
if self.__authenticate(login, password, authz_id, authmech):
return True
return False | Establish a connection with the server.
This function must be used. It read the server capabilities
and wraps calls to STARTTLS and AUTHENTICATE commands.
:param login: username
:param password: clear password
:param starttls: use a TLS connection or not
:param authmech: prefered authenticate mechanism
:rtype: boolean | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L485-L511 |
tonioo/sievelib | sievelib/managesieve.py | Client.capability | def capability(self):
"""Ask server capabilities.
See MANAGESIEVE specifications, section 2.4 This command does
not affect capabilities recorded by this client.
:rtype: string
"""
code, data, capabilities = (
self.__send_command("CAPABILITY", withcontent=True))
if code == "OK":
return capabilities
return None | python | def capability(self):
"""Ask server capabilities.
See MANAGESIEVE specifications, section 2.4 This command does
not affect capabilities recorded by this client.
:rtype: string
"""
code, data, capabilities = (
self.__send_command("CAPABILITY", withcontent=True))
if code == "OK":
return capabilities
return None | Ask server capabilities.
See MANAGESIEVE specifications, section 2.4 This command does
not affect capabilities recorded by this client.
:rtype: string | https://github.com/tonioo/sievelib/blob/88822d1f1daf30ef3dd9ac74911301b0773ef3c8/sievelib/managesieve.py#L520-L532 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.