def _refresh_content(self, rows ):
self.display_cache = Fifo( 10 * self.max_number_of_rows )
self.edit_cache = Fifo( 10 * self.max_number_of_rows )
self.attributes_cache = Fifo( 10 * self.max_number_of_rows )
locker = QtCore.QMutexLocker(self._mutex)
self.rows_under_request = set()
self.unflushed_rows = set()
locker.unlock()
self.setRowCount( rows )
def _refresh_content(self, rows):
assert object_thread(self)
locker = QtCore.QMutexLocker(self._mutex)
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
self.rows_under_request = set()
self.unflushed_rows = set()
# once the cache has been cleared, no updates ought to be accepted
self._update_requests = list()
locker.unlock()
self.setRowCount(rows)
def __init__(self, admin, model, initial_validation=False):
"""
:param mode: a collection proxy the validator should inspect, or None if only the objectValidity method is going
to get used.
:param verifiy_initial_validity: do an inital check to see if all rows in a model are valid, defaults to False,
since this might take a lot of time on large collections.
"""
super(ObjectValidator, self).__init__()
self.admin = admin
self.model = model
self.message_cache = Fifo(10)
if model:
model.dataChanged.connect( self.data_changed )
model.layoutChanged.connect( self.layout_changed )
self._invalid_rows = set()
if initial_validation:
post(self.validate_all_rows)
def _refresh_content(self, rows):
assert object_thread(self)
# if rows is None, other requests are on their way
if rows is not None:
locker = QtCore.QMutexLocker(self._mutex)
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
self.action_state_cache = Fifo(10 * self.max_number_of_rows)
self.rows_under_request = set()
self.unflushed_rows = set()
# once the cache has been cleared, no updates ought to be accepted
self._update_requests = list()
locker.unlock()
self.setRowCount(rows)
def _refresh_content(self, rows):
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
locker = QtCore.QMutexLocker(self._mutex)
self.rows_under_request = set()
self.unflushed_rows = set()
locker.unlock()
self.setRowCount(rows)
def __init__(self, admin, model = None, initial_validation = False):
"""
:param mode: a collection proxy the validator should inspect, or None if only the objectValidity method is going
to get used.
:param verifiy_initial_validity: do an inital check to see if all rows in a model are valid, defaults to False,
since this might take a lot of time on large collections.
"""
super(ObjectValidator, self).__init__()
self.admin = admin
self.model = model
self.message_cache = Fifo(10)
if model:
model.dataChanged.connect( self.data_changed )
model.layoutChanged.connect( self.layout_changed )
self._invalid_rows = set()
if initial_validation:
post(self.validate_all_rows)
def __init__( self,
admin,
collection_getter,
columns_getter,
max_number_of_rows = 10,
edits = None,
flush_changes = True,
cache_collection_proxy = None
):
"""
:param admin: the admin interface for the items in the collection
:param collection_getter: a function that takes no arguments and returns
the collection that will be visualized. This function will be called inside
the model thread, to prevent delays when this function causes the database
to be hit. If the collection is a list, it should not contain any duplicate
elements.
:param columns_getter: a function that takes no arguments and returns the
columns that will be cached in the proxy. This function will be called
inside the model thread.
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
from camelot.view.model_thread import get_model_thread
self.logger = logging.getLogger(logger.name + '.%s'%id(self))
self.logger.debug('initialize query table for %s' % (admin.get_verbose_name()))
self._mutex = QtCore.QMutex()
self.admin = admin
self._horizontal_header_height = QtGui.QFontMetrics( self._header_font_required ).height() + 10
vertical_header_font_height = QtGui.QFontMetrics( self._header_font ).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.iconSize = QtCore.QSize( vertical_header_font_height,
vertical_header_font_height )
if self.header_icon:
self.form_icon = QtCore.QVariant( self.header_icon.getQIcon().pixmap( self.iconSize ) )
else:
self.form_icon = QtCore.QVariant()
self.validator = admin.create_validator( self )
self._collection_getter = collection_getter
self.column_count = 0
self.flush_changes = flush_changes
self.delegate_manager = None
self.mt = get_model_thread()
# Set database connection and load data
self._rows = 0
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
if cache_collection_proxy:
self.display_cache = cache_collection_proxy.display_cache.shallow_copy( 10 * self.max_number_of_rows )
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy( 10 * self.max_number_of_rows )
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy( 10 * self.max_number_of_rows )
else:
self.display_cache = Fifo( 10 * self.max_number_of_rows )
self.edit_cache = Fifo( 10 * self.max_number_of_rows )
self.attributes_cache = Fifo( 10 * self.max_number_of_rows )
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
# Set edits
self.edits = edits or []
self.row_changed_signal.connect( self._emit_changes )
self.rsh = get_signal_handler()
self.rsh.connect_signals( self )
def get_columns():
self._columns = columns_getter()
self._static_field_attributes = list(self.admin.get_static_field_attributes([c[0] for c in self._columns]))
return self._columns
post( get_columns, self.setColumns )
# # the initial collection might contain unflushed rows
post( self.updateUnflushedRows )
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount( cache_collection_proxy.rowCount() )
else:
post( self.getRowCount, self.setRowCount )
self.logger.debug( 'initialization finished' )
class CollectionProxy( QtCore.QAbstractTableModel ):
"""The CollectionProxy contains a limited copy of the data in the actual
collection, usable for fast visualisation in a QTableView
the CollectionProxy has some class attributes that can be overwritten when
subclassing it :
* header_icon : the icon to be used in the vertical header
"""
_header_font = QtGui.QApplication.font()
_header_font_required = QtGui.QApplication.font()
_header_font_required.setBold( True )
header_icon = Icon( 'tango/16x16/places/folder.png' )
item_delegate_changed_signal = QtCore.pyqtSignal()
row_changed_signal = QtCore.pyqtSignal(int)
exception_signal = QtCore.pyqtSignal(object)
rows_removed_signal = QtCore.pyqtSignal()
@gui_function
def __init__( self,
admin,
collection_getter,
columns_getter,
max_number_of_rows = 10,
edits = None,
flush_changes = True,
cache_collection_proxy = None
):
"""
:param admin: the admin interface for the items in the collection
:param collection_getter: a function that takes no arguments and returns
the collection that will be visualized. This function will be called inside
the model thread, to prevent delays when this function causes the database
to be hit. If the collection is a list, it should not contain any duplicate
elements.
:param columns_getter: a function that takes no arguments and returns the
columns that will be cached in the proxy. This function will be called
inside the model thread.
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
from camelot.view.model_thread import get_model_thread
self.logger = logging.getLogger(logger.name + '.%s'%id(self))
self.logger.debug('initialize query table for %s' % (admin.get_verbose_name()))
self._mutex = QtCore.QMutex()
self.admin = admin
self._horizontal_header_height = QtGui.QFontMetrics( self._header_font_required ).height() + 10
vertical_header_font_height = QtGui.QFontMetrics( self._header_font ).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.iconSize = QtCore.QSize( vertical_header_font_height,
vertical_header_font_height )
if self.header_icon:
self.form_icon = QtCore.QVariant( self.header_icon.getQIcon().pixmap( self.iconSize ) )
else:
self.form_icon = QtCore.QVariant()
self.validator = admin.create_validator( self )
self._collection_getter = collection_getter
self.column_count = 0
self.flush_changes = flush_changes
self.delegate_manager = None
self.mt = get_model_thread()
# Set database connection and load data
self._rows = 0
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
if cache_collection_proxy:
self.display_cache = cache_collection_proxy.display_cache.shallow_copy( 10 * self.max_number_of_rows )
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy( 10 * self.max_number_of_rows )
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy( 10 * self.max_number_of_rows )
else:
self.display_cache = Fifo( 10 * self.max_number_of_rows )
self.edit_cache = Fifo( 10 * self.max_number_of_rows )
self.attributes_cache = Fifo( 10 * self.max_number_of_rows )
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
# Set edits
self.edits = edits or []
self.row_changed_signal.connect( self._emit_changes )
self.rsh = get_signal_handler()
self.rsh.connect_signals( self )
def get_columns():
self._columns = columns_getter()
self._static_field_attributes = list(self.admin.get_static_field_attributes([c[0] for c in self._columns]))
return self._columns
post( get_columns, self.setColumns )
# # the initial collection might contain unflushed rows
post( self.updateUnflushedRows )
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount( cache_collection_proxy.rowCount() )
else:
post( self.getRowCount, self.setRowCount )
self.logger.debug( 'initialization finished' )
@property
def max_number_of_rows(self):
"""The maximum number of rows to be displayed at once"""
return self._max_number_of_rows
def get_validator(self):
return self.validator
def map_to_source(self, sorted_row_number):
"""Converts a sorted row number to a row number of the source
collection"""
return self._sort_and_filter[sorted_row_number]
@model_function
def updateUnflushedRows( self ):
"""Verify all rows to see if some of them should be added to the
unflushed rows"""
for i, e in enumerate( self.get_collection() ):
if hasattr(e, 'id') and not e.id:
self.unflushed_rows.add( i )
def hasUnflushedRows( self ):
"""The model has rows that have not been flushed to the database yet,
because the row is invalid
"""
has_unflushed_rows = ( len( self.unflushed_rows ) > 0 )
self.logger.debug( 'hasUnflushed rows : %s' % has_unflushed_rows )
return has_unflushed_rows
@model_function
def getRowCount( self ):
# make sure we don't count an object twice if it is twice
# in the list, since this will drive the cache nuts
rows = len( set( self.get_collection() ) )
return rows
@gui_function
def revertRow( self, row ):
def create_refresh_entity( row ):
@model_function
def refresh_entity():
o = self._get_object( row )
self.admin.refresh( o )
return row, o
return refresh_entity
post( create_refresh_entity( row ), self._revert_row )
@QtCore.pyqtSlot(tuple)
@gui_function
def _revert_row(self, row_and_entity ):
row, entity = row_and_entity
self.handleRowUpdate( row )
self.rsh.sendEntityUpdate( self, entity )
@gui_function
def refresh( self ):
post( self.getRowCount, self._refresh_content )
@QtCore.pyqtSlot(int)
@gui_function
def _refresh_content(self, rows ):
self.display_cache = Fifo( 10 * self.max_number_of_rows )
self.edit_cache = Fifo( 10 * self.max_number_of_rows )
self.attributes_cache = Fifo( 10 * self.max_number_of_rows )
locker = QtCore.QMutexLocker(self._mutex)
self.rows_under_request = set()
self.unflushed_rows = set()
locker.unlock()
self.setRowCount( rows )
def set_collection_getter( self, collection_getter ):
self.logger.debug('set collection getter')
self._collection_getter = collection_getter
self.refresh()
@model_function
def get_collection( self ):
return self._collection_getter()
@gui_function
def handleRowUpdate( self, row ):
"""Handles the update of a row when this row might be out of date"""
self.display_cache.delete_by_row( row )
self.edit_cache.delete_by_row( row )
self.attributes_cache.delete_by_row( row )
self.dataChanged.emit( self.index( row, 0 ),
self.index( row, self.column_count ) )
@QtCore.pyqtSlot( object, object )
def handle_entity_update( self, sender, entity ):
"""Handles the entity signal, indicating that the model is out of
date"""
self.logger.debug( '%s %s received entity update signal' % \
( self.__class__.__name__, self.admin.get_verbose_name() ) )
if sender != self:
try:
row = self.display_cache.get_row_by_entity(entity)
except KeyError:
self.logger.debug( 'entity not in cache' )
return
#
# Because the entity is updated, it might no longer be in our
# collection, therefore, make sure we don't access the collection
# to strip data of the entity
#
def create_entity_update(row, entity):
def entity_update():
columns = self.getColumns()
self._add_data(columns, row, entity)
return row
return entity_update
post(create_entity_update(row, entity), self._emit_changes)
else:
self.logger.debug( 'duplicate update' )
@QtCore.pyqtSlot( object, object )
def handle_entity_delete( self, sender, entity ):
"""Handles the entity signal, indicating that the model is out of
date"""
self.logger.debug( 'received entity delete signal' )
if sender != self:
self.refresh()
@QtCore.pyqtSlot( object, object )
def handle_entity_create( self, sender, entity ):
"""Handles the entity signal, indicating that the model is out of
date"""
self.logger.debug( 'received entity create signal' )
if sender != self:
self.refresh()
@QtCore.pyqtSlot(int)
def setRowCount( self, rows ):
"""Callback method to set the number of rows
@param rows the new number of rows
"""
self._rows = rows
if not sip.isdeleted(self):
self.layoutChanged.emit()
def getItemDelegate( self ):
""":return: a DelegateManager for this model, or None if no DelegateManager yet available
a DelegateManager will be available once the item_delegate_changed signal has been emitted"""
self.logger.debug( 'getItemDelegate' )
return self.delegate_manager
def getColumns( self ):
""":return: the columns as set by the setColumns method"""
return self._columns
@QtCore.pyqtSlot(object)
@gui_function
def setColumns( self, columns ):
"""Callback method to set the columns
:param columns: a list with fields to be displayed of the form [('field_name', field_attributes), ...] as
returned by the getColumns method of the ElixirAdmin class
"""
self.logger.debug( 'setColumns' )
self.column_count = len( columns )
self._columns = columns
delegate_manager = delegates.DelegateManager()
delegate_manager.set_columns_desc( columns )
# set a delegate for the vertical header
delegate_manager.insertColumnDelegate( -1, delegates.PlainTextDelegate(parent = delegate_manager) )
#
# this loop can take a while to complete, so processEvents is called regulary
#
for i, c in enumerate( columns ):
# if i%10==0:
# QtCore.QCoreApplication.processEvents(QtCore.QEventLoop.ExcludeSocketNotifiers, 100)
field_name = c[0]
self.logger.debug( 'creating delegate for %s' % field_name )
if 'delegate' in c[1]:
try:
delegate = c[1]['delegate']( parent = delegate_manager, **c[1] )
except Exception, e:
logger.error('ProgrammingError : could not create delegate for field %s'%field_name, exc_info=e)
delegate = delegates.PlainTextDelegate( parent = delegate_manager, **c[1] )
delegate_manager.insertColumnDelegate( i, delegate )
continue
elif c[1]['python_type'] == str:
if c[1]['length']:
delegate = delegates.PlainTextDelegate( parent = delegate_manager, maxlength = c[1]['length'] )
delegate_manager.insertColumnDelegate( i, delegate )
else:
delegate = delegates.TextEditDelegate( parent = delegate_manager, **c[1] )
delegate_manager.insertColumnDelegate( i, delegate )
else:
class CollectionProxy(QtGui.QProxyModel):
"""The CollectionProxy contains a limited copy of the data in the actual
collection, usable for fast visualisation in a QTableView
the CollectionProxy has some class attributes that can be overwritten when
subclassing it :
* header_icon : the icon to be used in the vertical header
"""
_header_font = QtGui.QApplication.font()
_header_font_required = QtGui.QApplication.font()
_header_font_required.setBold(True)
header_icon = Icon("tango/16x16/places/folder.png")
item_delegate_changed_signal = QtCore.pyqtSignal()
row_changed_signal = QtCore.pyqtSignal(int)
exception_signal = QtCore.pyqtSignal(object)
rows_removed_signal = QtCore.pyqtSignal()
# it looks as QtCore.QModelIndex cannot be serialized for cross
# thread signals
_rows_about_to_be_inserted_signal = QtCore.pyqtSignal(int, int)
_rows_inserted_signal = QtCore.pyqtSignal(int, int)
def __init__(
self,
admin,
collection_getter,
columns_getter,
max_number_of_rows=10,
flush_changes=True,
cache_collection_proxy=None,
):
"""
:param admin: the admin interface for the items in the collection
:param collection_getter: a function that takes no arguments and returns
the collection that will be visualized. This function will be called inside
the model thread, to prevent delays when this function causes the database
to be hit. If the collection is a list, it should not contain any duplicate
elements.
:param columns_getter: a function that takes no arguments and returns the
columns that will be cached in the proxy. This function will be called
inside the model thread.
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
assert object_thread(self)
from camelot.view.model_thread import get_model_thread
#
# The source model will contain the actual data stripped from the
# objects in the collection.
#
self.source_model = QtGui.QStandardItemModel()
self.setModel(self.source_model)
self.logger = logging.getLogger(logger.name + ".%s" % id(self))
self.logger.debug("initialize query table for %s" % (admin.get_verbose_name()))
self._mutex = QtCore.QMutex()
self.admin = admin
self.settings = self.admin.get_settings()
self._horizontal_header_height = QtGui.QFontMetrics(self._header_font_required).height() + 10
self._header_font_metrics = QtGui.QFontMetrics(self._header_font)
vertical_header_font_height = QtGui.QFontMetrics(self._header_font).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.iconSize = QtCore.QSize(vertical_header_font_height, vertical_header_font_height)
if self.header_icon:
self.form_icon = QtCore.QVariant(self.header_icon.getQIcon().pixmap(self.iconSize))
else:
self.form_icon = QtCore.QVariant()
self.validator = admin.create_validator(self)
self._collection_getter = collection_getter
self.flush_changes = flush_changes
self.delegate_manager = None
self.mt = get_model_thread()
# Set database connection and load data
self._rows = 0
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
max_cache = 10 * self.max_number_of_rows
if cache_collection_proxy:
cached_entries = len(cache_collection_proxy.display_cache)
max_cache = max(cached_entries, max_cache)
self.display_cache = cache_collection_proxy.display_cache.shallow_copy(max_cache)
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy(max_cache)
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy(max_cache)
else:
self.display_cache = Fifo(max_cache)
self.edit_cache = Fifo(max_cache)
self.attributes_cache = Fifo(max_cache)
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
self.row_changed_signal.connect(self._emit_changes)
self._rows_about_to_be_inserted_signal.connect(self._rows_about_to_be_inserted, Qt.QueuedConnection)
self._rows_inserted_signal.connect(self._rows_inserted, Qt.QueuedConnection)
self.rsh = get_signal_handler()
self.rsh.connect_signals(self)
def get_columns():
self._columns = columns_getter()
self._static_field_attributes = list(self.admin.get_static_field_attributes([c[0] for c in self._columns]))
return self._columns
post(get_columns, self.setColumns)
# # the initial collection might contain unflushed rows
post(self._update_unflushed_rows)
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount(cache_collection_proxy.rowCount())
else:
post(self.getRowCount, self.setRowCount)
self.logger.debug("initialization finished")
#
# Reimplementation of methods of QProxyModel, because for now, we only
# use the proxy to store header data
#
# Subsequent calls to this function should return the same index
#
def index(self, row, col, parent=QtCore.QModelIndex()):
assert object_thread(self)
if self.hasIndex(row, col, parent):
#
# indexes are considered equal when their row, column and internal
# pointer are equal. therefor set the internal pointer always to 0.
#
return self.createIndex(row, col, 0)
return QtCore.QModelIndex()
def parent(self, child):
assert object_thread(self)
return QtCore.QModelIndex()
def rowCount(self, index=None):
return self._rows
def hasChildren(self, parent):
assert object_thread(self)
return False
#
# end or reimplementation
#
#
# begin functions related to drag and drop
#
def mimeTypes(self):
assert object_thread(self)
if self.admin.drop_action != None:
return self.admin.drop_action.drop_mime_types
def supportedDropActions(self):
assert object_thread(self)
if self.admin.drop_action != None:
return Qt.CopyAction | Qt.MoveAction | Qt.LinkAction
return None
def dropMimeData(self, mime_data, action, row, column, parent):
assert object_thread(self)
# print mime_data, [unicode(f) for f in mime_data.formats()]
return True
#
# end of drag and drop related functions
#
@property
def max_number_of_rows(self):
"""The maximum number of rows to be displayed at once"""
return self._max_number_of_rows
def get_validator(self):
return self.validator
def map_to_source(self, sorted_row_number):
"""Converts a sorted row number to a row number of the source
collection"""
return self._sort_and_filter[sorted_row_number]
@model_function
def _update_unflushed_rows(self):
"""Verify all rows to see if some of them should be added to the
unflushed rows"""
for i, e in enumerate(self.get_collection()):
if hasattr(e, "id") and not e.id:
self.unflushed_rows.add(i)
def hasUnflushedRows(self):
"""The model has rows that have not been flushed to the database yet,
because the row is invalid
"""
has_unflushed_rows = len(self.unflushed_rows) > 0
self.logger.debug("hasUnflushed rows : %s" % has_unflushed_rows)
return has_unflushed_rows
@model_function
def getRowCount(self):
# make sure we don't count an object twice if it is twice
# in the list, since this will drive the cache nuts
rows = len(set(self.get_collection()))
return rows
def refresh(self):
assert object_thread(self)
post(self.getRowCount, self._refresh_content)
@QtCore.pyqtSlot(int)
def _refresh_content(self, rows):
assert object_thread(self)
locker = QtCore.QMutexLocker(self._mutex)
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
self.rows_under_request = set()
self.unflushed_rows = set()
# once the cache has been cleared, no updates ought to be accepted
self._update_requests = list()
locker.unlock()
self.setRowCount(rows)
def set_collection_getter(self, collection_getter):
self.logger.debug("set collection getter")
self._collection_getter = collection_getter
self.refresh()
@model_function
def get_collection(self):
return self._collection_getter()
def handleRowUpdate(self, row):
"""Handles the update of a row when this row might be out of date"""
assert object_thread(self)
self.display_cache.delete_by_row(row)
self.edit_cache.delete_by_row(row)
self.attributes_cache.delete_by_row(row)
self.dataChanged.emit(self.index(row, 0), self.index(row, self.columnCount() - 1))
@QtCore.pyqtSlot(object, object)
def handle_entity_update(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug(
"%s %s received entity update signal" % (self.__class__.__name__, self.admin.get_verbose_name())
)
if sender != self:
try:
row = self.display_cache.get_row_by_entity(entity)
except KeyError:
self.logger.debug("entity not in cache")
return
#
# Because the entity is updated, it might no longer be in our
# collection, therefore, make sure we don't access the collection
# to strip data of the entity
#
def create_entity_update(row, entity):
def entity_update():
columns = self._columns
self._add_data(columns, row, entity)
return row
return entity_update
post(create_entity_update(row, entity), self._emit_changes)
else:
self.logger.debug("duplicate update")
@QtCore.pyqtSlot(object, object)
def handle_entity_delete(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug("received entity delete signal")
if sender != self:
try:
row = self.display_cache.get_row_by_entity(entity)
except KeyError:
self.logger.debug("entity not in cache")
return
self.remove_rows([row], delete=False)
@QtCore.pyqtSlot(object, object)
def handle_entity_create(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug("received entity create signal")
# @todo : decide what to do when a new entity has been created,
# probably do nothing
return
@QtCore.pyqtSlot(int)
def setRowCount(self, rows):
"""Callback method to set the number of rows
@param rows the new number of rows
"""
assert object_thread(self)
self._rows = rows
self.layoutChanged.emit()
def getItemDelegate(self):
""":return: a DelegateManager for this model, or None if no DelegateManager yet available
a DelegateManager will be available once the item_delegate_changed signal has been emitted"""
assert object_thread(self)
self.logger.debug("getItemDelegate")
return self.delegate_manager
def getColumns(self):
""":return: the columns as set by the setColumns method"""
return self._columns
@QtCore.pyqtSlot(object)
def setColumns(self, columns):
"""Callback method to set the columns
:param columns: a list with fields to be displayed of the form [('field_name', field_attributes), ...] as
returned by the getColumns method of the ElixirAdmin class
"""
assert object_thread(self)
self.logger.debug("setColumns")
self._columns = columns
delegate_manager = delegates.DelegateManager()
delegate_manager.set_columns_desc(columns)
# set a delegate for the vertical header
delegate_manager.insertColumnDelegate(-1, delegates.PlainTextDelegate(parent=delegate_manager))
index = QtCore.QModelIndex()
option = QtGui.QStyleOptionViewItem()
self.settings.beginGroup("column_width")
self.settings.beginGroup("0")
#
# this loop can take a while to complete, so processEvents is called regulary
#
for i, c in enumerate(columns):
#
# Construct the delegate
#
field_name = c[0]
self.logger.debug("creating delegate for %s" % field_name)
try:
delegate = c[1]["delegate"](parent=delegate_manager, **c[1])
except Exception, e:
log_programming_error(logger, "Could not create delegate for field %s" % field_name, exc_info=e)
delegate = delegates.PlainTextDelegate(parent=delegate_manager, **c[1])
delegate_manager.insertColumnDelegate(i, delegate)
#
# Set the header data
#
header_item = QtGui.QStandardItem()
header_item.setData(QtCore.QVariant(unicode(c[1]["name"])), Qt.DisplayRole)
if c[1].get("nullable", True) == False:
header_item.setData(self._header_font_required, Qt.FontRole)
else:
header_item.setData(self._header_font, Qt.FontRole)
settings_width = int(variant_to_pyobject(self.settings.value(field_name, 0)))
label_size = QtGui.QFontMetrics(self._header_font_required).size(
Qt.TextSingleLine, unicode(c[1]["name"]) + u" "
)
minimal_widths = [label_size.width() + 10]
if "minimal_column_width" in c[1]:
minimal_widths.append(self._header_font_metrics.averageCharWidth() * c[1]["minimal_column_width"])
if c[1].get("editable", True) != False:
minimal_widths.append(delegate.sizeHint(option, index).width())
column_width = c[1].get("column_width", None)
if column_width != None:
minimal_widths = [self._header_font_metrics.averageCharWidth() * column_width]
if settings_width:
header_item.setData(
QtCore.QVariant(QtCore.QSize(settings_width, self._horizontal_header_height)), Qt.SizeHintRole
)
else:
header_item.setData(
QtCore.QVariant(QtCore.QSize(max(minimal_widths), self._horizontal_header_height)), Qt.SizeHintRole
)
self.source_model.setHorizontalHeaderItem(i, header_item)
self.settings.endGroup()
self.settings.endGroup()
# Only set the delegate manager when it is fully set up
self.delegate_manager = delegate_manager
self.item_delegate_changed_signal.emit()
class ObjectValidator(QtCore.QObject):
"""A validator class for normal python objects. By default this validator
declares all objects valid. Subclass this class and overwrite it's
objectValidity method to change it's behaviour.
"""
validity_changed_signal = QtCore.pyqtSignal(int)
def __init__(self, admin, model = None, initial_validation = False):
"""
:param mode: a collection proxy the validator should inspect, or None if only the objectValidity method is going
to get used.
:param verifiy_initial_validity: do an inital check to see if all rows in a model are valid, defaults to False,
since this might take a lot of time on large collections.
"""
super(ObjectValidator, self).__init__()
self.admin = admin
self.model = model
self.message_cache = Fifo(10)
if model:
model.dataChanged.connect( self.data_changed )
model.layoutChanged.connect( self.layout_changed )
self._invalid_rows = set()
if initial_validation:
post(self.validate_all_rows)
def validate_all_rows(self):
"""Force validation of all rows in the model"""
for row in range(self.model.getRowCount()):
self.isValid(row)
def validate_invalid_rows(self):
for row in copy(self._invalid_rows):
self.isValid(row)
@QtCore.pyqtSlot()
def layout_changed(self):
post(self.validate_invalid_rows)
@QtCore.pyqtSlot( QtCore.QModelIndex, QtCore.QModelIndex )
def data_changed(self, from_index, thru_index):
def create_validity_updater(from_row, thru_row):
def validity_updater():
for i in range(from_row, thru_row+1):
self.isValid(i)
return validity_updater
post(create_validity_updater(from_index.row(), thru_index.row()))
def objectValidity(self, entity_instance):
""":return: list of messages explaining invalid data
empty list if object is valid
"""
from camelot.view.controls import delegates
messages = []
fields_and_attributes = dict(self.admin.get_columns())
fields_and_attributes.update(dict(self.admin.get_fields()))
for field, attributes in fields_and_attributes.items():
# if the field was not editable, don't waste any time
if attributes['editable']:
#
# If the field embeds another object, that object should be valid as well
#
if attributes.get('embedded', False) and attributes.get('target', False):
value = getattr(entity_instance, field)
if value:
target_admin = self.admin.get_related_admin(attributes['target'])
target_validator = target_admin.create_validator(None)
messages.extend( target_validator.objectValidity(value) )
continue
# if the field, is nullable, don't waste time getting its value
# @todo: check if field is a primary key instead of checking
# whether the name is id, but this should only happen in the entity validator
if attributes['nullable']!=True and field!='id':
value = getattr(entity_instance, field)
logger.debug('column %s is required'%(field))
if 'delegate' not in attributes:
raise Exception('no delegate specified for %s'%(field))
is_null = False
if value==None:
is_null = True
elif (attributes['delegate'] == delegates.CodeDelegate) and \
(sum(len(c) for c in value) == 0):
is_null = True
elif (attributes['delegate'] == delegates.PlainTextDelegate) and (len(value) == 0):
is_null = True
elif (attributes['delegate'] == delegates.Many2OneDelegate) and (not value.id):
is_null = True
elif (attributes['delegate'] == delegates.VirtualAddressDelegate) and (not value[1]):
is_null = True
if is_null:
messages.append(_(u'%s is a required field') % (attributes['name']))
logger.debug(u'messages : %s'%(u','.join(messages)))
return messages
def number_of_invalid_rows(self):
"""
:return: the number of invalid rows in a model, as they have been verified
"""
return len(self._invalid_rows)
def isValid(self, row):
"""Verify if a row in a model is 'valid' meaning it could be flushed to
the database
"""
messages = []
logger.debug('isValid for row %s' % row)
try:
entity_instance = self.model._get_object(row)
if entity_instance != None:
messages = self.objectValidity(entity_instance)
self.message_cache.add_data(row, entity_instance, messages)
except Exception, e:
logger.error(
'programming error while validating object',
exc_info=e
)
valid = (len(messages) == 0)
if not valid:
if row not in self._invalid_rows:
self._invalid_rows.add(row)
self.validity_changed_signal.emit( row )
elif row in self._invalid_rows:
self._invalid_rows.remove(row)
self.validity_changed_signal.emit( row )
logger.debug('valid : %s' % valid)
return valid
def __init__(self,
admin,
collection_getter,
columns_getter,
max_number_of_rows=10,
edits=None,
flush_changes=True,
cache_collection_proxy=None):
"""
:param admin: the admin interface for the items in the collection
:param collection_getter: a function that takes no arguments and returns
the collection that will be visualized. This function will be called inside
the model thread, to prevent delays when this function causes the database
to be hit. If the collection is a list, it should not contain any duplicate
elements.
:param columns_getter: a function that takes no arguments and returns the
columns that will be cached in the proxy. This function will be called
inside the model thread.
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
from camelot.view.model_thread import get_model_thread
self.logger = logging.getLogger(logger.name + '.%s' % id(self))
self.logger.debug('initialize query table for %s' %
(admin.get_verbose_name()))
self._mutex = QtCore.QMutex()
self.admin = admin
self._horizontal_header_height = QtGui.QFontMetrics(
self._header_font_required).height() + 10
vertical_header_font_height = QtGui.QFontMetrics(
self._header_font).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.iconSize = QtCore.QSize(vertical_header_font_height,
vertical_header_font_height)
if self.header_icon:
self.form_icon = QtCore.QVariant(
self.header_icon.getQIcon().pixmap(self.iconSize))
else:
self.form_icon = QtCore.QVariant()
self.validator = admin.create_validator(self)
self._collection_getter = collection_getter
self.column_count = 0
self.flush_changes = flush_changes
self.delegate_manager = None
self.mt = get_model_thread()
# Set database connection and load data
self._rows = 0
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
if cache_collection_proxy:
self.display_cache = cache_collection_proxy.display_cache.shallow_copy(
10 * self.max_number_of_rows)
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy(
10 * self.max_number_of_rows)
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy(
10 * self.max_number_of_rows)
else:
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
# Set edits
self.edits = edits or []
self.row_changed_signal.connect(self._emit_changes)
self.rsh = get_signal_handler()
self.rsh.connect_signals(self)
def get_columns():
self._columns = columns_getter()
self._static_field_attributes = list(
self.admin.get_static_field_attributes(
[c[0] for c in self._columns]))
return self._columns
post(get_columns, self.setColumns)
# # the initial collection might contain unflushed rows
post(self.updateUnflushedRows)
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount(cache_collection_proxy.rowCount())
else:
post(self.getRowCount, self.setRowCount)
self.logger.debug('initialization finished')
class CollectionProxy(QtCore.QAbstractTableModel):
"""The CollectionProxy contains a limited copy of the data in the actual
collection, usable for fast visualisation in a QTableView
the CollectionProxy has some class attributes that can be overwritten when
subclassing it :
* header_icon : the icon to be used in the vertical header
"""
_header_font = QtGui.QApplication.font()
_header_font_required = QtGui.QApplication.font()
_header_font_required.setBold(True)
header_icon = Icon('tango/16x16/places/folder.png')
item_delegate_changed_signal = QtCore.pyqtSignal()
row_changed_signal = QtCore.pyqtSignal(int)
exception_signal = QtCore.pyqtSignal(object)
rows_removed_signal = QtCore.pyqtSignal()
@gui_function
def __init__(self,
admin,
collection_getter,
columns_getter,
max_number_of_rows=10,
edits=None,
flush_changes=True,
cache_collection_proxy=None):
"""
:param admin: the admin interface for the items in the collection
:param collection_getter: a function that takes no arguments and returns
the collection that will be visualized. This function will be called inside
the model thread, to prevent delays when this function causes the database
to be hit. If the collection is a list, it should not contain any duplicate
elements.
:param columns_getter: a function that takes no arguments and returns the
columns that will be cached in the proxy. This function will be called
inside the model thread.
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
from camelot.view.model_thread import get_model_thread
self.logger = logging.getLogger(logger.name + '.%s' % id(self))
self.logger.debug('initialize query table for %s' %
(admin.get_verbose_name()))
self._mutex = QtCore.QMutex()
self.admin = admin
self._horizontal_header_height = QtGui.QFontMetrics(
self._header_font_required).height() + 10
vertical_header_font_height = QtGui.QFontMetrics(
self._header_font).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.iconSize = QtCore.QSize(vertical_header_font_height,
vertical_header_font_height)
if self.header_icon:
self.form_icon = QtCore.QVariant(
self.header_icon.getQIcon().pixmap(self.iconSize))
else:
self.form_icon = QtCore.QVariant()
self.validator = admin.create_validator(self)
self._collection_getter = collection_getter
self.column_count = 0
self.flush_changes = flush_changes
self.delegate_manager = None
self.mt = get_model_thread()
# Set database connection and load data
self._rows = 0
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
if cache_collection_proxy:
self.display_cache = cache_collection_proxy.display_cache.shallow_copy(
10 * self.max_number_of_rows)
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy(
10 * self.max_number_of_rows)
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy(
10 * self.max_number_of_rows)
else:
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
# Set edits
self.edits = edits or []
self.row_changed_signal.connect(self._emit_changes)
self.rsh = get_signal_handler()
self.rsh.connect_signals(self)
def get_columns():
self._columns = columns_getter()
self._static_field_attributes = list(
self.admin.get_static_field_attributes(
[c[0] for c in self._columns]))
return self._columns
post(get_columns, self.setColumns)
# # the initial collection might contain unflushed rows
post(self.updateUnflushedRows)
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount(cache_collection_proxy.rowCount())
else:
post(self.getRowCount, self.setRowCount)
self.logger.debug('initialization finished')
@property
def max_number_of_rows(self):
"""The maximum number of rows to be displayed at once"""
return self._max_number_of_rows
def get_validator(self):
return self.validator
def map_to_source(self, sorted_row_number):
"""Converts a sorted row number to a row number of the source
collection"""
return self._sort_and_filter[sorted_row_number]
@model_function
def updateUnflushedRows(self):
"""Verify all rows to see if some of them should be added to the
unflushed rows"""
for i, e in enumerate(self.get_collection()):
if hasattr(e, 'id') and not e.id:
self.unflushed_rows.add(i)
def hasUnflushedRows(self):
"""The model has rows that have not been flushed to the database yet,
because the row is invalid
"""
has_unflushed_rows = (len(self.unflushed_rows) > 0)
self.logger.debug('hasUnflushed rows : %s' % has_unflushed_rows)
return has_unflushed_rows
@model_function
def getRowCount(self):
# make sure we don't count an object twice if it is twice
# in the list, since this will drive the cache nuts
rows = len(set(self.get_collection()))
return rows
@gui_function
def revertRow(self, row):
def create_refresh_entity(row):
@model_function
def refresh_entity():
o = self._get_object(row)
self.admin.refresh(o)
return row, o
return refresh_entity
post(create_refresh_entity(row), self._revert_row)
@QtCore.pyqtSlot(tuple)
@gui_function
def _revert_row(self, row_and_entity):
row, entity = row_and_entity
self.handleRowUpdate(row)
self.rsh.sendEntityUpdate(self, entity)
@gui_function
def refresh(self):
post(self.getRowCount, self._refresh_content)
@QtCore.pyqtSlot(int)
@gui_function
def _refresh_content(self, rows):
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
locker = QtCore.QMutexLocker(self._mutex)
self.rows_under_request = set()
self.unflushed_rows = set()
locker.unlock()
self.setRowCount(rows)
def set_collection_getter(self, collection_getter):
self.logger.debug('set collection getter')
self._collection_getter = collection_getter
self.refresh()
@model_function
def get_collection(self):
return self._collection_getter()
@gui_function
def handleRowUpdate(self, row):
"""Handles the update of a row when this row might be out of date"""
self.display_cache.delete_by_row(row)
self.edit_cache.delete_by_row(row)
self.attributes_cache.delete_by_row(row)
self.dataChanged.emit(self.index(row, 0),
self.index(row, self.column_count))
@QtCore.pyqtSlot(object, object)
def handle_entity_update(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
self.logger.debug( '%s %s received entity update signal' % \
( self.__class__.__name__, self.admin.get_verbose_name() ) )
if sender != self:
try:
row = self.display_cache.get_row_by_entity(entity)
except KeyError:
self.logger.debug('entity not in cache')
return
#
# Because the entity is updated, it might no longer be in our
# collection, therefore, make sure we don't access the collection
# to strip data of the entity
#
def create_entity_update(row, entity):
def entity_update():
columns = self.getColumns()
self._add_data(columns, row, entity)
return row
return entity_update
post(create_entity_update(row, entity), self._emit_changes)
else:
self.logger.debug('duplicate update')
@QtCore.pyqtSlot(object, object)
def handle_entity_delete(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
self.logger.debug('received entity delete signal')
if sender != self:
self.refresh()
@QtCore.pyqtSlot(object, object)
def handle_entity_create(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
self.logger.debug('received entity create signal')
if sender != self:
self.refresh()
@QtCore.pyqtSlot(int)
def setRowCount(self, rows):
"""Callback method to set the number of rows
@param rows the new number of rows
"""
self._rows = rows
if not sip.isdeleted(self):
self.layoutChanged.emit()
def getItemDelegate(self):
""":return: a DelegateManager for this model, or None if no DelegateManager yet available
a DelegateManager will be available once the item_delegate_changed signal has been emitted"""
self.logger.debug('getItemDelegate')
return self.delegate_manager
def getColumns(self):
""":return: the columns as set by the setColumns method"""
return self._columns
@QtCore.pyqtSlot(object)
@gui_function
def setColumns(self, columns):
"""Callback method to set the columns
:param columns: a list with fields to be displayed of the form [('field_name', field_attributes), ...] as
returned by the getColumns method of the ElixirAdmin class
"""
self.logger.debug('setColumns')
self.column_count = len(columns)
self._columns = columns
delegate_manager = delegates.DelegateManager()
delegate_manager.set_columns_desc(columns)
# set a delegate for the vertical header
delegate_manager.insertColumnDelegate(
-1, delegates.PlainTextDelegate(parent=delegate_manager))
#
# this loop can take a while to complete, so processEvents is called regulary
#
for i, c in enumerate(columns):
# if i%10==0:
# QtCore.QCoreApplication.processEvents(QtCore.QEventLoop.ExcludeSocketNotifiers, 100)
field_name = c[0]
self.logger.debug('creating delegate for %s' % field_name)
if 'delegate' in c[1]:
try:
delegate = c[1]['delegate'](parent=delegate_manager,
**c[1])
except Exception, e:
logger.error(
'ProgrammingError : could not create delegate for field %s'
% field_name,
exc_info=e)
delegate = delegates.PlainTextDelegate(
parent=delegate_manager, **c[1])
delegate_manager.insertColumnDelegate(i, delegate)
continue
elif c[1]['python_type'] == str:
if c[1]['length']:
delegate = delegates.PlainTextDelegate(
parent=delegate_manager, maxlength=c[1]['length'])
delegate_manager.insertColumnDelegate(i, delegate)
else:
delegate = delegates.TextEditDelegate(
parent=delegate_manager, **c[1])
delegate_manager.insertColumnDelegate(i, delegate)
else:
class ObjectValidator(QtCore.QObject):
"""A validator class for normal python objects. By default this validator
declares all objects valid. Subclass this class and overwrite it's
objectValidity method to change it's behaviour.
"""
validity_changed_signal = QtCore.pyqtSignal(int)
def __init__(self, admin, model, initial_validation=False):
"""
:param mode: a collection proxy the validator should inspect, or None if only the objectValidity method is going
to get used.
:param verifiy_initial_validity: do an inital check to see if all rows in a model are valid, defaults to False,
since this might take a lot of time on large collections.
"""
super(ObjectValidator, self).__init__()
self.admin = admin
self.model = model
self.message_cache = Fifo(10)
if model:
model.dataChanged.connect( self.data_changed )
model.layoutChanged.connect( self.layout_changed )
self._invalid_rows = set()
if initial_validation:
post(self.validate_all_rows)
def validate_all_rows(self):
"""Force validation of all rows in the model"""
for row in range(self.model.getRowCount()):
self.isValid(row)
def validate_invalid_rows(self):
for row in copy(self._invalid_rows):
self.isValid(row)
@QtCore.pyqtSlot()
def layout_changed(self):
post(self.validate_invalid_rows)
@QtCore.pyqtSlot( QtCore.QModelIndex, QtCore.QModelIndex )
def data_changed(self, from_index, thru_index):
def create_validity_updater(from_row, thru_row):
def validity_updater():
for i in range(from_row, thru_row+1):
self.isValid(i)
return validity_updater
post(create_validity_updater(from_index.row(), thru_index.row()))
def objectValidity(self, entity_instance):
""":return: list of messages explaining invalid data
empty list if object is valid
"""
from camelot.view.controls import delegates
messages = []
fields_and_attributes = dict(self.admin.get_columns())
fields_and_attributes.update(dict(self.admin.get_fields()))
for field, attributes in fields_and_attributes.items():
# if the field was not editable, don't waste any time
if attributes['editable']:
#
# If the field embeds another object, that object should be valid as well
#
if attributes.get('embedded', False) and attributes.get('target', False):
value = getattr(entity_instance, field)
if value:
target_admin = self.admin.get_related_entity_admin(attributes['target'])
target_validator = target_admin.create_validator(None)
messages.extend( target_validator.objectValidity(value) )
continue
# if the field, is nullable, don't waste time getting its value
# @todo: check if field is a primary key instead of checking
# whether the name is id, but this should only happen in the entity validator
if attributes['nullable']!=True and field!='id':
value = getattr(entity_instance, field)
logger.debug('column %s is required'%(field))
if 'delegate' not in attributes:
raise Exception('no delegate specified for %s'%(field))
is_null = False
if value==None:
is_null = True
elif (attributes['delegate'] == delegates.CodeDelegate) and \
(sum(len(c) for c in value) == 0):
is_null = True
elif (attributes['delegate'] == delegates.PlainTextDelegate) and (len(value) == 0):
is_null = True
elif (attributes['delegate'] == delegates.Many2OneDelegate) and (not value.id):
is_null = True
elif (attributes['delegate'] == delegates.VirtualAddressDelegate) and (not value[1]):
is_null = True
if is_null:
messages.append(_(u'%s is a required field') % (attributes['name']))
logger.debug(u'messages : %s'%(u','.join(messages)))
return messages
def number_of_invalid_rows(self):
"""
:return: the number of invalid rows in a model, as they have been verified
"""
return len(self._invalid_rows)
def isValid(self, row):
"""Verify if a row in a model is 'valid' meaning it could be flushed to
the database
"""
messages = []
logger.debug('isValid for row %s' % row)
try:
entity_instance = self.model._get_object(row)
if entity_instance:
messages = self.objectValidity(entity_instance)
self.message_cache.add_data(row, entity_instance, messages)
except Exception, e:
logger.error(
'programming error while validating object',
exc_info=e
)
valid = (len(messages) == 0)
if not valid:
if row not in self._invalid_rows:
self._invalid_rows.add(row)
self.validity_changed_signal.emit( row )
elif row in self._invalid_rows:
self._invalid_rows.remove(row)
self.validity_changed_signal.emit( row )
logger.debug('valid : %s' % valid)
return valid
class CollectionProxy(QtGui.QProxyModel):
"""The CollectionProxy contains a limited copy of the data in the actual
collection, usable for fast visualisation in a QTableView
the CollectionProxy has some class attributes that can be overwritten when
subclassing it :
* header_icon : the icon to be used in the vertical header
"""
_header_font = QtGui.QApplication.font()
_header_font_required = QtGui.QApplication.font()
_header_font_required.setBold(True)
header_icon = Icon('tango/16x16/places/folder.png')
item_delegate_changed_signal = QtCore.pyqtSignal()
row_changed_signal = QtCore.pyqtSignal(int)
exception_signal = QtCore.pyqtSignal(object)
rows_removed_signal = QtCore.pyqtSignal()
# it looks as QtCore.QModelIndex cannot be serialized for cross
# thread signals
_rows_about_to_be_inserted_signal = QtCore.pyqtSignal(int, int)
_rows_inserted_signal = QtCore.pyqtSignal(int, int)
def __init__(self,
admin,
collection_getter,
columns_getter,
max_number_of_rows=10,
flush_changes=True,
cache_collection_proxy=None):
"""
:param admin: the admin interface for the items in the collection
:param collection_getter: a function that takes no arguments and returns
the collection that will be visualized. This function will be called inside
the model thread, to prevent delays when this function causes the database
to be hit. If the collection is a list, it should not contain any duplicate
elements.
:param columns_getter: a function that takes no arguments and returns the
columns that will be cached in the proxy. This function will be called
inside the model thread.
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
assert object_thread(self)
from camelot.view.model_thread import get_model_thread
#
# The source model will contain the actual data stripped from the
# objects in the collection.
#
self.source_model = QtGui.QStandardItemModel()
self.setModel(self.source_model)
self.logger = logging.getLogger(logger.name + '.%s' % id(self))
self.logger.debug('initialize query table for %s' %
(admin.get_verbose_name()))
self._mutex = QtCore.QMutex()
self.admin = admin
self.settings = self.admin.get_settings()
self._horizontal_header_height = QtGui.QFontMetrics(
self._header_font_required).height() + 10
self._header_font_metrics = QtGui.QFontMetrics(self._header_font)
vertical_header_font_height = QtGui.QFontMetrics(
self._header_font).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.iconSize = QtCore.QSize(vertical_header_font_height,
vertical_header_font_height)
if self.header_icon:
self.form_icon = QtCore.QVariant(
self.header_icon.getQIcon().pixmap(self.iconSize))
else:
self.form_icon = QtCore.QVariant()
self.validator = admin.get_validator(self)
self._collection_getter = collection_getter
self.flush_changes = flush_changes
self.delegate_manager = None
self.mt = get_model_thread()
# Set database connection and load data
self._rows = 0
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
max_cache = 10 * self.max_number_of_rows
if cache_collection_proxy:
cached_entries = len(cache_collection_proxy.display_cache)
max_cache = max(cached_entries, max_cache)
self.display_cache = cache_collection_proxy.display_cache.shallow_copy(
max_cache)
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy(
max_cache)
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy(
max_cache)
else:
self.display_cache = Fifo(max_cache)
self.edit_cache = Fifo(max_cache)
self.attributes_cache = Fifo(max_cache)
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
self.row_changed_signal.connect(self._emit_changes)
self._rows_about_to_be_inserted_signal.connect(
self._rows_about_to_be_inserted, Qt.QueuedConnection)
self._rows_inserted_signal.connect(self._rows_inserted,
Qt.QueuedConnection)
self.rsh = get_signal_handler()
self.rsh.connect_signals(self)
def get_columns():
self._columns = columns_getter()
self._static_field_attributes = list(
self.admin.get_static_field_attributes(
[c[0] for c in self._columns]))
return self._columns
post(get_columns, self.setColumns)
# # the initial collection might contain unflushed rows
post(self._update_unflushed_rows)
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount(cache_collection_proxy.rowCount())
else:
post(self.getRowCount, self.setRowCount)
self.logger.debug('initialization finished')
#
# Reimplementation of methods of QProxyModel, because for now, we only
# use the proxy to store header data
#
# Subsequent calls to this function should return the same index
#
def index(self, row, col, parent=QtCore.QModelIndex()):
assert object_thread(self)
if self.hasIndex(row, col, parent):
#
# indexes are considered equal when their row, column and internal
# pointer are equal. therefor set the internal pointer always to 0.
#
return self.createIndex(row, col, 0)
return QtCore.QModelIndex()
def parent(self, child):
assert object_thread(self)
return QtCore.QModelIndex()
def rowCount(self, index=None):
return self._rows
def hasChildren(self, parent):
assert object_thread(self)
return False
#
# end or reimplementation
#
#
# begin functions related to drag and drop
#
def mimeTypes(self):
assert object_thread(self)
if self.admin.drop_action != None:
return self.admin.drop_action.drop_mime_types
def supportedDropActions(self):
assert object_thread(self)
if self.admin.drop_action != None:
return Qt.CopyAction | Qt.MoveAction | Qt.LinkAction
return None
def dropMimeData(self, mime_data, action, row, column, parent):
assert object_thread(self)
#print mime_data, [unicode(f) for f in mime_data.formats()]
return True
#
# end of drag and drop related functions
#
@property
def max_number_of_rows(self):
"""The maximum number of rows to be displayed at once"""
return self._max_number_of_rows
def get_validator(self):
return self.validator
def map_to_source(self, sorted_row_number):
"""Converts a sorted row number to a row number of the source
collection"""
return self._sort_and_filter[sorted_row_number]
@model_function
def _update_unflushed_rows(self):
"""Verify all rows to see if some of them should be added to the
unflushed rows"""
for i, e in enumerate(self.get_collection()):
if hasattr(e, 'id') and not e.id:
self.unflushed_rows.add(i)
def hasUnflushedRows(self):
"""The model has rows that have not been flushed to the database yet,
because the row is invalid
"""
has_unflushed_rows = (len(self.unflushed_rows) > 0)
self.logger.debug('hasUnflushed rows : %s' % has_unflushed_rows)
return has_unflushed_rows
@model_function
def getRowCount(self):
# make sure we don't count an object twice if it is twice
# in the list, since this will drive the cache nuts
rows = len(set(self.get_collection()))
return rows
def refresh(self):
assert object_thread(self)
post(self.getRowCount, self._refresh_content)
@QtCore.pyqtSlot(int)
def _refresh_content(self, rows):
assert object_thread(self)
locker = QtCore.QMutexLocker(self._mutex)
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
self.rows_under_request = set()
self.unflushed_rows = set()
# once the cache has been cleared, no updates ought to be accepted
self._update_requests = list()
locker.unlock()
self.setRowCount(rows)
def set_collection_getter(self, collection_getter):
self.logger.debug('set collection getter')
self._collection_getter = collection_getter
self.refresh()
@model_function
def get_collection(self):
return self._collection_getter()
def handleRowUpdate(self, row):
"""Handles the update of a row when this row might be out of date"""
assert object_thread(self)
self.display_cache.delete_by_row(row)
self.edit_cache.delete_by_row(row)
self.attributes_cache.delete_by_row(row)
self.dataChanged.emit(self.index(row, 0),
self.index(row,
self.columnCount() - 1))
@QtCore.pyqtSlot(object, object)
def handle_entity_update(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug( '%s %s received entity update signal' % \
( self.__class__.__name__, self.admin.get_verbose_name() ) )
if sender != self:
try:
row = self.display_cache.get_row_by_entity(entity)
except KeyError:
self.logger.debug('entity not in cache')
return
#
# Because the entity is updated, it might no longer be in our
# collection, therefore, make sure we don't access the collection
# to strip data of the entity
#
def create_entity_update(row, entity):
def entity_update():
columns = self._columns
self._add_data(columns, row, entity)
return row
return entity_update
post(create_entity_update(row, entity), self._emit_changes)
else:
self.logger.debug('duplicate update')
@QtCore.pyqtSlot(object, object)
def handle_entity_delete(self, sender, obj):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug('received entity delete signal')
if sender != self:
try:
self.display_cache.get_row_by_entity(obj)
except KeyError:
self.logger.debug('entity not in cache')
return
def entity_remove(obj):
self.remove(obj)
self.display_cache.delete_by_entity(obj)
self.attributes_cache.delete_by_entity(obj)
self.edit_cache.delete_by_entity(obj)
return self._rows
post(entity_remove, self._refresh_content, args=(obj, ))
@QtCore.pyqtSlot(object, object)
def handle_entity_create(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug('received entity create signal')
# @todo : decide what to do when a new entity has been created,
# probably do nothing
return
@QtCore.pyqtSlot(int)
def setRowCount(self, rows):
"""Callback method to set the number of rows
@param rows the new number of rows
"""
assert object_thread(self)
self._rows = rows
self.layoutChanged.emit()
def getItemDelegate(self):
""":return: a DelegateManager for this model, or None if no DelegateManager yet available
a DelegateManager will be available once the item_delegate_changed signal has been emitted"""
assert object_thread(self)
self.logger.debug('getItemDelegate')
return self.delegate_manager
def getColumns(self):
""":return: the columns as set by the setColumns method"""
return self._columns
@QtCore.pyqtSlot(object)
def setColumns(self, columns):
"""Callback method to set the columns
:param columns: a list with fields to be displayed of the form [('field_name', field_attributes), ...] as
returned by the getColumns method of the ElixirAdmin class
"""
assert object_thread(self)
self.logger.debug('setColumns')
self._columns = columns
delegate_manager = delegates.DelegateManager()
delegate_manager.set_columns_desc(columns)
# set a delegate for the vertical header
delegate_manager.insertColumnDelegate(
-1, delegates.PlainTextDelegate(parent=delegate_manager))
index = QtCore.QModelIndex()
option = QtGui.QStyleOptionViewItem()
self.settings.beginGroup('column_width')
self.settings.beginGroup('0')
#
# this loop can take a while to complete, so processEvents is called regulary
#
for i, c in enumerate(columns):
#
# Construct the delegate
#
field_name = c[0]
self.logger.debug('creating delegate for %s' % field_name)
try:
delegate = c[1]['delegate'](parent=delegate_manager, **c[1])
except Exception, e:
log_programming_error(
logger,
'Could not create delegate for field %s' % field_name,
exc_info=e)
delegate = delegates.PlainTextDelegate(parent=delegate_manager,
**c[1])
delegate_manager.insertColumnDelegate(i, delegate)
#
# Set the header data
#
header_item = QtGui.QStandardItem()
header_item.setData(QtCore.QVariant(unicode(c[1]['name'])),
Qt.DisplayRole)
if c[1].get('nullable', True) == False:
header_item.setData(self._header_font_required, Qt.FontRole)
else:
header_item.setData(self._header_font, Qt.FontRole)
settings_width = int(
variant_to_pyobject(self.settings.value(field_name, 0)))
label_size = QtGui.QFontMetrics(self._header_font_required).size(
Qt.TextSingleLine,
unicode(c[1]['name']) + u' ')
minimal_widths = [label_size.width() + 10]
if 'minimal_column_width' in c[1]:
minimal_widths.append(
self._header_font_metrics.averageCharWidth() *
c[1]['minimal_column_width'])
if c[1].get('editable', True) != False:
minimal_widths.append(delegate.sizeHint(option, index).width())
column_width = c[1].get('column_width', None)
if column_width != None:
minimal_widths = [
self._header_font_metrics.averageCharWidth() * column_width
]
if settings_width:
header_item.setData(
QtCore.QVariant(
QtCore.QSize(settings_width,
self._horizontal_header_height)),
Qt.SizeHintRole)
else:
header_item.setData(
QtCore.QVariant(
QtCore.QSize(max(minimal_widths),
self._horizontal_header_height)),
Qt.SizeHintRole)
self.source_model.setHorizontalHeaderItem(i, header_item)
self.settings.endGroup()
self.settings.endGroup()
# Only set the delegate manager when it is fully set up
self.delegate_manager = delegate_manager
self.item_delegate_changed_signal.emit()
def __init__(
self,
admin,
max_number_of_rows=10,
flush_changes=True,
cache_collection_proxy=None,
):
"""
:param admin: the admin interface for the items in the collection
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
assert object_thread(self)
from camelot.view.model_thread import get_model_thread
#
# The source model will contain the actual data stripped from the
# objects in the collection.
#
self.source_model = QtGui.QStandardItemModel()
self.setSourceModel(self.source_model)
self.logger = logging.getLogger(logger.name + '.%s' % id(self))
self.logger.debug('initialize query table for %s' %
(admin.get_verbose_name()))
# the mutex is recursive to avoid blocking during unittest, when
# model and view are used in the same thread
self._mutex = QtCore.QMutex(QtCore.QMutex.Recursive)
self.admin = admin
self.list_action = admin.list_action
self.row_model_context = RowModelContext()
self.row_model_context.admin = admin
self.settings = self.admin.get_settings()
self._horizontal_header_height = QtGui.QFontMetrics(
self._header_font_required).height() + 10
self._header_font_metrics = QtGui.QFontMetrics(self._header_font)
vertical_header_font_height = QtGui.QFontMetrics(
self._header_font).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.vertical_header_size = QtCore.QSize(16 + 10,
self._vertical_header_height)
self.validator = admin.get_validator(self)
self._collection = []
self.flush_changes = flush_changes
self.mt = get_model_thread()
# Set database connection and load data
self._rows = None
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
max_cache = 10 * self.max_number_of_rows
if cache_collection_proxy:
cached_entries = len(cache_collection_proxy.display_cache)
max_cache = max(cached_entries, max_cache)
self.display_cache = cache_collection_proxy.display_cache.shallow_copy(
max_cache)
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy(
max_cache)
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy(
max_cache)
self.action_state_cache = cache_collection_proxy.action_state_cache.shallow_copy(
max_cache)
else:
self.display_cache = Fifo(max_cache)
self.edit_cache = Fifo(max_cache)
self.attributes_cache = Fifo(max_cache)
self.action_state_cache = Fifo(max_cache)
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
self._rowcount_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
self.row_changed_signal.connect(self._emit_changes)
self._rows_about_to_be_inserted_signal.connect(
self._rows_about_to_be_inserted, Qt.QueuedConnection)
self._rows_inserted_signal.connect(self._rows_inserted,
Qt.QueuedConnection)
self.rsh = get_signal_handler()
self.rsh.connect_signals(self)
# # the initial collection might contain unflushed rows
post(self._update_unflushed_rows)
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount(cache_collection_proxy.rowCount())
self.logger.debug('initialization finished')
class CollectionProxy(QtModel.QSortFilterProxyModel):
"""The :class:`CollectionProxy` contains a limited copy of the data in the
actual collection, usable for fast visualisation in a
:class:`QtWidgets.QTableView`
The behavior of the :class:`QtWidgets.QTableView`, such as what happens when the
user clicks on a row is defined in the :class:`ObjectAdmin` class.
"""
row_changed_signal = QtCore.qt_signal(int, int, int)
exception_signal = QtCore.qt_signal(object)
rows_removed_signal = QtCore.qt_signal()
# it looks as QtCore.QModelIndex cannot be serialized for cross
# thread signals
_rows_about_to_be_inserted_signal = QtCore.qt_signal(int, int)
_rows_inserted_signal = QtCore.qt_signal(int, int)
def __init__(
self,
admin,
max_number_of_rows=10,
flush_changes=True,
cache_collection_proxy=None,
):
"""
:param admin: the admin interface for the items in the collection
:param cache_collection_proxy: the CollectionProxy on which this CollectionProxy
will reuse the cache. Passing a cache has the advantage that objects that were
present in the original cache will remain at the same row in the new cache
This is used when a form is created from a tableview. Because between the last
query of the tableview, and the first of the form, the object might have changed
position in the query.
"""
super(CollectionProxy, self).__init__()
assert object_thread(self)
from camelot.view.model_thread import get_model_thread
#
# The source model will contain the actual data stripped from the
# objects in the collection.
#
self.source_model = QtGui.QStandardItemModel()
self.setSourceModel(self.source_model)
self.logger = logging.getLogger(logger.name + '.%s' % id(self))
self.logger.debug('initialize query table for %s' %
(admin.get_verbose_name()))
# the mutex is recursive to avoid blocking during unittest, when
# model and view are used in the same thread
self._mutex = QtCore.QMutex(QtCore.QMutex.Recursive)
self.admin = admin
self.list_action = admin.list_action
self.row_model_context = RowModelContext()
self.row_model_context.admin = admin
self.settings = self.admin.get_settings()
self._horizontal_header_height = QtGui.QFontMetrics(
self._header_font_required).height() + 10
self._header_font_metrics = QtGui.QFontMetrics(self._header_font)
vertical_header_font_height = QtGui.QFontMetrics(
self._header_font).height()
self._vertical_header_height = vertical_header_font_height * self.admin.lines_per_row + 10
self.vertical_header_size = QtCore.QSize(16 + 10,
self._vertical_header_height)
self.validator = admin.get_validator(self)
self._collection = []
self.flush_changes = flush_changes
self.mt = get_model_thread()
# Set database connection and load data
self._rows = None
self._columns = []
self._static_field_attributes = []
self._max_number_of_rows = max_number_of_rows
max_cache = 10 * self.max_number_of_rows
if cache_collection_proxy:
cached_entries = len(cache_collection_proxy.display_cache)
max_cache = max(cached_entries, max_cache)
self.display_cache = cache_collection_proxy.display_cache.shallow_copy(
max_cache)
self.edit_cache = cache_collection_proxy.edit_cache.shallow_copy(
max_cache)
self.attributes_cache = cache_collection_proxy.attributes_cache.shallow_copy(
max_cache)
self.action_state_cache = cache_collection_proxy.action_state_cache.shallow_copy(
max_cache)
else:
self.display_cache = Fifo(max_cache)
self.edit_cache = Fifo(max_cache)
self.attributes_cache = Fifo(max_cache)
self.action_state_cache = Fifo(max_cache)
# The rows in the table for which a cache refill is under request
self.rows_under_request = set()
self._update_requests = list()
self._rowcount_requests = list()
# The rows that have unflushed changes
self.unflushed_rows = set()
self._sort_and_filter = SortingRowMapper()
self.row_changed_signal.connect(self._emit_changes)
self._rows_about_to_be_inserted_signal.connect(
self._rows_about_to_be_inserted, Qt.QueuedConnection)
self._rows_inserted_signal.connect(self._rows_inserted,
Qt.QueuedConnection)
self.rsh = get_signal_handler()
self.rsh.connect_signals(self)
# # the initial collection might contain unflushed rows
post(self._update_unflushed_rows)
# # in that way the number of rows is requested as well
if cache_collection_proxy:
self.setRowCount(cache_collection_proxy.rowCount())
self.logger.debug('initialization finished')
@hybrid_property
def _header_font(cls):
return QtWidgets.QApplication.font()
@hybrid_property
def _header_font_required(cls):
font = QtWidgets.QApplication.font()
font.setBold(True)
return font
#
# Reimplementation of methods of QProxyModel, because for now, we only
# use the proxy to store header data
#
# Subsequent calls to this function should return the same index
#
def index(self, row, col, parent=QtCore.QModelIndex()):
assert object_thread(self)
if self.hasIndex(row, col, parent):
#
# indexes are considered equal when their row, column and internal
# pointer are equal. therefor set the internal pointer always to 0.
#
return self.createIndex(row, col, 0)
return QtCore.QModelIndex()
def parent(self, child):
assert object_thread(self)
return QtCore.QModelIndex()
def rowCount(self, index=None):
if self._rows is None:
self.refresh()
return 0
return self._rows
def hasChildren(self, parent):
assert object_thread(self)
return False
def buddy(self, index):
return index
#
# end or reimplementation
#
#
# begin functions related to drag and drop
#
def mimeTypes(self):
assert object_thread(self)
if self.admin.drop_action != None:
return self.admin.drop_action.drop_mime_types
def supportedDropActions(self):
assert object_thread(self)
if self.admin.drop_action != None:
return Qt.CopyAction | Qt.MoveAction | Qt.LinkAction
return None
def dropMimeData(self, mime_data, action, row, column, parent):
assert object_thread(self)
return True
#
# end of drag and drop related functions
#
@property
def max_number_of_rows(self):
"""The maximum number of rows to be displayed at once"""
return self._max_number_of_rows
def get_validator(self):
return self.validator
def map_to_source(self, sorted_row_number):
"""Converts a sorted row number to a row number of the source
collection"""
return self._sort_and_filter[sorted_row_number]
def _update_unflushed_rows(self):
"""Verify all rows to see if some of them should be added to the
unflushed rows"""
for i, e in enumerate(self.get_collection()):
if hasattr(e, 'id') and not e.id:
self.unflushed_rows.add(i)
def hasUnflushedRows(self):
"""The model has rows that have not been flushed to the database yet,
because the row is invalid
"""
has_unflushed_rows = (len(self.unflushed_rows) > 0)
self.logger.debug('hasUnflushed rows : %s' % has_unflushed_rows)
return has_unflushed_rows
def getRowCount(self):
#
# wait for a while until the rowcount requests array doesn't change any
# more
#
previous_length = 0
locker = QtCore.QMutexLocker(self._mutex)
while previous_length != len(self._rowcount_requests):
previous_length = len(self._rowcount_requests)
locker.unlock()
QtCore.QThread.msleep(5)
locker.relock()
self._rowcount_requests.pop()
# make sure we don't count an object twice if it is twice
# in the list, since this will drive the cache nuts
if len(self._rowcount_requests) == 0:
# this is the last request on its way, do the counting now
rows = len(set(self.get_collection()))
else:
# other row count reqests are on their way, do nothing now
rows = None
locker.unlock()
return rows
def refresh(self):
assert object_thread(self)
locker = QtCore.QMutexLocker(self._mutex)
self._rowcount_requests.append(True)
post(self.getRowCount, self._refresh_content)
locker.unlock()
@QtCore.qt_slot(int)
def _refresh_content(self, rows):
assert object_thread(self)
# if rows is None, other requests are on their way
if rows is not None:
locker = QtCore.QMutexLocker(self._mutex)
self.display_cache = Fifo(10 * self.max_number_of_rows)
self.edit_cache = Fifo(10 * self.max_number_of_rows)
self.attributes_cache = Fifo(10 * self.max_number_of_rows)
self.action_state_cache = Fifo(10 * self.max_number_of_rows)
self.rows_under_request = set()
self.unflushed_rows = set()
# once the cache has been cleared, no updates ought to be accepted
self._update_requests = list()
locker.unlock()
self.setRowCount(rows)
def set_value(self, collection):
"""
:param collection: the list of objects to display
"""
if collection is None:
collection = []
elif isinstance(collection, CollectionContainer):
collection = collection._collection
self._collection = collection
self.refresh()
def get_value(self):
return self._collection
def get_collection(self):
return self._collection
def handleRowUpdate(self, row):
"""Handles the update of a row when this row might be out of date"""
assert object_thread(self)
self.display_cache.delete_by_row(row)
self.edit_cache.delete_by_row(row)
self.attributes_cache.delete_by_row(row)
self.action_state_cache.delete_by_row(row)
self.dataChanged.emit(self.index(row, 0),
self.index(row,
self.columnCount() - 1))
@QtCore.qt_slot(object, object)
def handle_entity_update(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug( '%s %s received entity update signal' % \
( self.__class__.__name__, self.admin.get_verbose_name() ) )
if sender != self:
try:
row = self.display_cache.get_row_by_entity(entity)
except KeyError:
self.logger.debug('entity not in cache')
return
#
# Because the entity is updated, it might no longer be in our
# collection, therefore, make sure we don't access the collection
# to strip data of the entity
#
def create_entity_update(row, entity):
def entity_update():
columns = self._columns
self._add_data(columns, row, entity)
# the validity of an object might have changed when it was
# modified by an action
self.validator.isValid(row)
return entity_update
post(create_entity_update(row, entity))
else:
self.logger.debug('duplicate update')
@QtCore.qt_slot(object, object)
def handle_entity_delete(self, sender, obj):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug('received entity delete signal')
if sender != self:
try:
self.display_cache.get_row_by_entity(obj)
except KeyError:
self.logger.debug('entity not in cache')
return
def entity_remove(obj):
self.remove(obj)
self.display_cache.delete_by_entity(obj)
self.attributes_cache.delete_by_entity(obj)
self.edit_cache.delete_by_entity(obj)
self.action_state_cache.delete_by_entity(obj)
return self._rows
post(entity_remove, self._refresh_content, args=(obj, ))
@QtCore.qt_slot(object, object)
def handle_entity_create(self, sender, entity):
"""Handles the entity signal, indicating that the model is out of
date"""
assert object_thread(self)
self.logger.debug('received entity create signal')
# @todo : decide what to do when a new entity has been created,
# probably do nothing
return
@QtCore.qt_slot(object)
def setRowCount(self, rows):
"""Callback method to set the number of rows
@param rows the new number of rows
"""
assert object_thread(self)
if rows == None:
# other row counts are on their way, ignore this one
return
if self._rows != rows:
self._rows = rows
self.layoutChanged.emit()
elif rows != 0:
self.dataChanged.emit(self.index(0, 0),
self.index(rows - 1,
self.columnCount() - 1))
def get_static_field_attributes(self):
return list(
self.admin.get_static_field_attributes(
[c[0] for c in self._columns]))
@QtCore.qt_slot(object)
def set_static_field_attributes(self, static_fa):
self._static_field_attributes = static_fa
self.beginResetModel()
self.settings.beginGroup('column_width')
self.settings.beginGroup('0')
#
# this loop can take a while to complete
#
font_metrics = QtGui.QFontMetrics(self._header_font_required)
char_width = font_metrics.averageCharWidth()
source_model = self.sourceModel()
for i, (field_name, fa) in enumerate(self._columns):
verbose_name = six.text_type(fa['name'])
header_item = QtGui.QStandardItem()
set_header_data = header_item.setData
#
# Set the header data
#
set_header_data(py_to_variant(field_name), Qt.UserRole)
set_header_data(py_to_variant(verbose_name), Qt.DisplayRole)
if fa.get('nullable', True) == False:
set_header_data(self._header_font_required, Qt.FontRole)
else:
set_header_data(self._header_font, Qt.FontRole)
settings_width = int(
variant_to_py(self.settings.value(field_name, 0)))
if settings_width > 0:
width = settings_width
else:
width = fa['column_width'] * char_width
header_item.setData(
py_to_variant(
QtCore.QSize(width, self._horizontal_header_height)),
Qt.SizeHintRole)
source_model.setHorizontalHeaderItem(i, header_item)
self.settings.endGroup()
self.settings.endGroup()
self.endResetModel()
def set_columns(self, columns):
"""Callback method to set the columns
:param columns: a list with fields to be displayed of the form [('field_name', field_attributes), ...] as
returned by the `get_columns` method of the `EntityAdmin` class
"""
assert object_thread(self)
self.logger.debug('set_columns')
self._columns = columns
post(self.get_static_field_attributes,
self.set_static_field_attributes)
def setHeaderData(self, section, orientation, value, role):
assert object_thread(self)
if orientation == Qt.Horizontal:
if role == Qt.SizeHintRole:
width = value.width()
self.settings.beginGroup('column_width')
self.settings.beginGroup('0')
self.settings.setValue(self._columns[section][1]['field_name'],
width)
self.settings.endGroup()
self.settings.endGroup()
return super(CollectionProxy,
self).setHeaderData(section, orientation, value, role)
def headerData(self, section, orientation, role):
"""In case the columns have not been set yet, don't even try to get
information out of them
"""
assert object_thread(self)
if orientation == Qt.Vertical:
if role == Qt.SizeHintRole:
#
# sizehint role is requested, for every row, so we have to
# return a fixed value
#
return py_to_variant(self.vertical_header_size)
#
# get icon from action state
#
action_state = self._get_row_data(section,
self.action_state_cache)[0]
if action_state not in (None, ValueLoading):
icon = action_state.icon
if icon is not None:
if role == Qt.DecorationRole:
return icon.getQPixmap()
verbose_name = action_state.verbose_name
if verbose_name is not None:
if role == Qt.DisplayRole:
return py_to_variant(six.text_type(verbose_name))
tooltip = action_state.tooltip
if tooltip is not None:
if role == Qt.ToolTipRole:
return py_to_variant(six.text_type(tooltip))
return self.sourceModel().headerData(section, orientation, role)
def sort(self, column, order):
"""reimplementation of the :class:`QtGui.QAbstractItemModel` its sort function"""
assert object_thread(self)
def create_sort(column, order):
def sort():
unsorted_collection = [
(i, o) for i, o in enumerate(self.get_collection())
]
field_name = self._columns[column][0]
# handle the case of one of the values being None
def compare_none(line_1, line_2):
key_1, key_2 = None, None
try:
key_1 = getattr(line_1[1], field_name)
except Exception as e:
logger.error('could not get attribute %s from object' %
field_name,
exc_info=e)
try:
key_2 = getattr(line_2[1], field_name)
except Exception as e:
logger.error('could not get attribute %s from object' %
field_name,
exc_info=e)
if key_1 == None and key_2 == None:
return 0
if key_1 == None:
return -1
if key_2 == None:
return 1
return cmp(key_1, key_2)
unsorted_collection.sort(cmp=compare_none, reverse=order)
for j, (i, _o) in enumerate(unsorted_collection):
self._sort_and_filter[j] = i
return len(unsorted_collection)
return sort
post(create_sort(column, order), self._refresh_content)
def data(self, index, role=Qt.DisplayRole):
""":return: the data at index for the specified role
This function will return ValueLoading when the data has not
yet been fetched from the underlying model. It will then send
a request to the model thread to fetch this data. Once the data
is readily available, the dataChanged signal will be emitted
Using Qt.UserRole as a role will return all the field attributes
of the index.
Using Qt.UserRole+1 will return the object of which an attribute
is displayed in that specific cell
"""
assert object_thread(self)
if not index.isValid() or \
not ( 0 <= index.row() < self.rowCount( index ) ) or \
not ( 0 <= index.column() < self.columnCount() ):
if role == Qt.UserRole:
return py_to_variant({})
else:
return py_to_variant()
if role in (Qt.EditRole, Qt.DisplayRole):
if role == Qt.EditRole:
cache = self.edit_cache
else:
cache = self.display_cache
data = self._get_row_data(index.row(), cache)
value = data[index.column()]
if isinstance(value, datetime.datetime):
# Putting a python datetime into a Qt Variant and returning
# it to a PyObject seems to be buggy, therefore we chop the
# microseconds
if value:
value = QtCore.QDateTime(value.year, value.month,
value.day, value.hour,
value.minute, value.second)
elif isinstance(value, (list, dict)):
value = CollectionContainer(value)
return py_to_variant(value)
elif role == Qt.ToolTipRole:
return py_to_variant(
self._get_field_attribute_value(index, 'tooltip'))
elif role == Qt.BackgroundRole:
return py_to_variant(
self._get_field_attribute_value(index, 'background_color')
or py_to_variant())
elif role == Qt.UserRole:
field_attributes = ProxyDict(
self._static_field_attributes[index.column()])
dynamic_field_attributes = self._get_row_data(
index.row(), self.attributes_cache)[index.column()]
if dynamic_field_attributes != ValueLoading:
field_attributes.update(dynamic_field_attributes)
return py_to_variant(field_attributes)
elif role == Qt.UserRole + 1:
try:
return py_to_variant(
self.edit_cache.get_entity_at_row(index.row()))
except KeyError:
return py_to_variant(ValueLoading)
return py_to_variant()
def _get_field_attribute_value(self, index, field_attribute):
"""Get the values for the static and the dynamic field attributes at once
:return: the value of the field attribute"""
try:
return self._static_field_attributes[
index.column()][field_attribute]
except KeyError:
value = self._get_row_data(index.row(),
self.attributes_cache)[index.column()]
if value is ValueLoading:
return None
return value.get(field_attribute, None)
def _handle_update_requests(self):
#
# wait for a while until the update requests array doesn't change any
# more
#
previous_length = 0
locker = QtCore.QMutexLocker(self._mutex)
while previous_length != len(self._update_requests):
previous_length = len(self._update_requests)
locker.unlock()
QtCore.QThread.msleep(5)
locker.relock()
#
# Copy the update requests and clear the list of requests
#
update_requests = [u for u in self._update_requests]
self._update_requests = []
locker.unlock()
#
# Handle the requests
#
return_list = []
grouped_requests = collections.defaultdict(list)
for flushed, row, column, value in update_requests:
grouped_requests[row].append((flushed, column, value))
admin = self.admin
for row, request_group in six.iteritems(grouped_requests):
#
# don't use _get_object, but only update objects which are in the
# cache, otherwise it is not sure that the object updated is the
# one that was edited
#
o = self.edit_cache.get_entity_at_row(row)
if not o:
# the object might have been deleted from the collection while the editor
# was still open
self.logger.debug('this object is no longer in the collection')
try:
self.unflushed_rows.remove(row)
except KeyError:
pass
continue
#
# the object might have been deleted while an editor was open
#
if admin.is_deleted(o):
continue
changed = False
for flushed, column, value in request_group:
attribute, field_attributes = self._columns[column]
from sqlalchemy.exc import DatabaseError
new_value = value()
self.logger.debug('set data for row %s;col %s' % (row, column))
if new_value == ValueLoading:
continue
old_value = getattr(o, attribute)
value_changed = (new_value != old_value)
#
# In case the attribute is a OneToMany or ManyToMany, we cannot simply compare the
# old and new value to know if the object was changed, so we'll
# consider it changed anyway
#
direction = field_attributes.get('direction', None)
if direction in ('manytomany', 'onetomany'):
value_changed = True
if value_changed is not True:
continue
#
# now check if this column is editable, since editable might be
# dynamic and change after every change of the object
#
fields = [attribute]
for fa in admin.get_dynamic_field_attributes(o, fields):
# if editable is not in the field_attributes dict, it wasn't
# dynamic but static, so earlier checks should have
# intercepted this change
if fa.get('editable', True) == True:
# interrupt inner loop, so outer loop can be continued
break
else:
continue
# update the model
try:
admin.set_field_value(o, attribute, new_value)
#
# setting this attribute, might trigger a default function
# to return a value, that was not returned before
#
admin.set_defaults(o, include_nullable_fields=False)
except AttributeError as e:
self.logger.error(u"Can't set attribute %s to %s" %
(attribute, six.text_type(new_value)),
exc_info=e)
except TypeError:
# type error can be raised in case we try to set to a collection
pass
changed = value_changed or changed
if changed:
if self.flush_changes:
if self.validator.isValid(row):
# save the state before the update
was_persistent = admin.is_persistent(o)
try:
admin.flush(o)
except DatabaseError as e:
#@todo: when flushing fails, the object should not be removed from the unflushed rows ??
self.logger.error(
'Programming Error, could not flush object',
exc_info=e)
locker.relock()
try:
self.unflushed_rows.remove(row)
except KeyError:
pass
locker.unlock()
if was_persistent is False:
self.rsh.sendEntityCreate(self, o)
# update the cache
self._add_data(self._columns, row, o)
#@todo: update should only be sent remotely when flush was done
self.rsh.sendEntityUpdate(self, o)
for depending_obj in admin.get_depending_objects(o):
self.rsh.sendEntityUpdate(self, depending_obj)
return_list.append(((row, 0), (row, len(self._columns))))
elif flushed:
locker.relock()
self.logger.debug(
'old value equals new value, no need to flush this object')
try:
self.unflushed_rows.remove(row)
except KeyError:
pass
locker.unlock()
return return_list
def setData(self, index, value, role=Qt.EditRole):
"""Value should be a function taking no arguments that returns the data to
be set
This function will then be called in the model_thread
"""
assert object_thread(self)
#
# prevent data of being set in rows not actually in this model
#
if (not index.isValid()) or (index.model() != self):
return False
if role == Qt.EditRole:
# if the field is not editable, don't waste any time and get out of here
# editable should be explicitely True, since the _get_field_attribute_value
# might return intermediary values such as ValueLoading ??
if self._get_field_attribute_value(index, 'editable') != True:
return
locker = QtCore.QMutexLocker(self._mutex)
flushed = (index.row() not in self.unflushed_rows)
self.unflushed_rows.add(index.row())
self._update_requests.append(
(flushed, index.row(), index.column(), value))
locker.unlock()
post(self._handle_update_requests)
return True
# @todo : it seems Qt regulary crashes when dataChanged is emitted
# don't do the emit inside a slot, but rework the CollectionProxy
# to behave as an action that yields all it's updates
@QtCore.qt_slot(int, int, int)
def _emit_changes(self, row, from_column, thru_column):
assert object_thread(self)
# emit the headerDataChanged signal, to ensure the row icon is
# updated
self.headerDataChanged.emit(Qt.Vertical, row, row)
if thru_column >= from_column:
top_left = self.index(row, from_column)
bottom_right = self.index(row, thru_column)
self.dataChanged.emit(top_left, bottom_right)
def flags(self, index):
"""Returns the item flags for the given index"""
assert object_thread(self)
if not index.isValid() or \
not ( 0 <= index.row() <= self.rowCount( index ) ) or \
not ( 0 <= index.column() <= self.columnCount() ):
return Qt.NoItemFlags
flags = Qt.ItemIsEnabled | Qt.ItemIsSelectable
if self._get_field_attribute_value(index, 'editable'):
flags = flags | Qt.ItemIsEditable
if self.admin.drop_action != None:
flags = flags | Qt.ItemIsDropEnabled
return flags
def _add_data(self, columns, row, obj):
"""Add data from object o at a row in the cache
:param columns: the columns of which to strip data
:param row: the row in the cache into which to add data
:param obj: the object from which to strip the data
"""
action_state = None
if not self.admin.is_deleted(obj):
row_data = strip_data_from_object(obj, columns)
dynamic_field_attributes = list(
self.admin.get_dynamic_field_attributes(
obj, (c[0] for c in columns)))
static_field_attributes = self.admin.get_static_field_attributes(
(c[0] for c in columns))
unicode_row_data = stripped_data_to_unicode(
row_data, obj, static_field_attributes,
dynamic_field_attributes)
if self.list_action:
self.row_model_context.obj = obj
self.row_model_context.current_row = row
action_state = self.list_action.get_state(
self.row_model_context)
else:
row_data = [None] * len(columns)
dynamic_field_attributes = [{'editable': False}] * len(columns)
static_field_attributes = self.admin.get_static_field_attributes(
(c[0] for c in columns))
unicode_row_data = [u''] * len(columns)
# keep track of the columns that changed, to limit the
# number of editors/cells that need to be updated
changed_columns = set()
locker = QtCore.QMutexLocker(self._mutex)
changed_columns.update(self.edit_cache.add_data(row, obj, row_data))
changed_columns.update(
self.display_cache.add_data(row, obj, unicode_row_data))
changed_columns.update(
self.attributes_cache.add_data(row, obj, dynamic_field_attributes))
self.action_state_cache.add_data(row, obj, [action_state])
locker.unlock()
#
# it might be that the CollectionProxy is deleted on the Qt side of
# the application
#
if not is_deleted(self) and row != None:
if len(changed_columns) == len(columns):
# this is new data or everything has changed, dont waste any
# time to fine grained updates
self.row_changed_signal.emit(row, 0, len(columns) - 1)
elif len(changed_columns):
changed_columns = sorted(changed_columns)
next_changed_columns = changed_columns[1:] + [None]
from_column = changed_columns[0]
for changed_column, next_column in zip(changed_columns,
next_changed_columns):
if next_column != changed_column + 1:
self.row_changed_signal.emit(row, from_column,
changed_column)
from_column = next_column
else:
# only the header changed
self.row_changed_signal.emit(row, 1, 0)
def _skip_row(self, row, obj):
""":return: True if the object obj is already in the cache, but at a
different row then row. If this is the case, this object should not
be put in the cache at row, and this row should be skipped alltogether.
"""
try:
return self.edit_cache.get_row_by_entity(obj) != row
except KeyError:
pass
return False
def _offset_and_limit_rows_to_get(self):
"""From the current set of rows to get, find the first
continuous range of rows that should be fetched.
:return: (offset, limit)
"""
offset, limit, previous_length, i = 0, 0, 0, 0
#
# wait for a while until the rows under request don't change any
# more
#
locker = QtCore.QMutexLocker(self._mutex)
while previous_length != len(self.rows_under_request):
previous_length = len(self.rows_under_request)
locker.unlock()
QtCore.QThread.msleep(5)
locker.relock()
#
# now filter out all rows that have been put in the cache
# the gui thread didn't know about
#
rows_to_get = self.rows_under_request
rows_already_there = set()
for row in rows_to_get:
if self.edit_cache.has_data_at_row(row):
rows_already_there.add(row)
rows_to_get.difference_update(rows_already_there)
rows_to_get = list(rows_to_get)
locker.unlock()
#
# see if there is anything left to do
#
try:
if len(rows_to_get):
rows_to_get.sort()
offset = rows_to_get[0]
#
# find first discontinuity
#
for i in range(offset, rows_to_get[-1] + 1):
if rows_to_get[i - offset] != i:
break
limit = i - offset + 1
except IndexError as e:
logger.error('index error with rows_to_get %s' %
six.text_type(rows_to_get),
exc_info=e)
raise e
return (offset, limit)
def _extend_cache(self):
"""Extend the cache around the rows under request"""
offset, limit = self._offset_and_limit_rows_to_get()
if limit:
columns = self._columns
collection = self.get_collection()
skipped_rows = 0
try:
for i in range(offset, min(offset + limit + 1,
len(collection))):
object_found = False
while not object_found:
unsorted_row = self._sort_and_filter[i]
obj = collection[unsorted_row + skipped_rows]
if self._skip_row(i, obj):
skipped_rows = skipped_rows + 1
else:
self._add_data(columns, i, obj)
object_found = True
except IndexError:
# stop when the end of the collection is reached, no matter
# what the request was
pass
self._cache_extended(offset, limit)
def _get_object(self, sorted_row_number):
"""Get the object corresponding to row
:return: the object at row row or None if the row index is invalid
"""
try:
# first try to get the primary key out of the cache, if it's not
# there, query the collection_getter
return self.edit_cache.get_entity_at_row(sorted_row_number)
except KeyError:
pass
try:
return self.get_collection()[self.map_to_source(sorted_row_number)]
except IndexError:
pass
return None
def _cache_extended(self, offset, limit):
"""
Remove the range within offset, limit from rows under request, this should
happen in the model thread, since they are consumed here
"""
locker = QtCore.QMutexLocker(self._mutex)
self.rows_under_request.difference_update(
set(range(offset, offset + limit + 1)))
locker.unlock()
def _get_row_data(self, row, cache):
"""Get the data which is to be visualized at a certain row of the
table, if needed, post a refill request the cache to get the object
and its neighbours in the cache, meanwhile, return an empty object
:param row: the row of the table for which to get the data
:param cache: the cache out of which to get row data
:return: row_data
"""
assert row >= 0
try:
data = cache.get_data_at_row(row)
#
# check if data is None, then the cache was a copy of previous
# cache, and the data should be refetched
#
if data is None:
raise KeyError
return data
except KeyError:
locker = QtCore.QMutexLocker(self._mutex)
if row not in self.rows_under_request:
self.rows_under_request.add(row)
#
# unlock before posting to model thread, since in the
# single threaded mode, the model thread function needs to
# acquire the lock
#
locker.unlock()
post(self._extend_cache)
return empty_row_data
def remove(self, o):
collection = self.get_collection()
if o in collection:
collection.remove(o)
self._rows -= 1
def append(self, o):
collection = self.get_collection()
if o not in collection:
collection.append(o)
@QtCore.qt_slot(int, int)
def _rows_about_to_be_inserted(self, first, last):
self.beginInsertRows(QtCore.QModelIndex(), first, last)
@QtCore.qt_slot(int, int)
def _rows_inserted(self, _first, _last):
self.endInsertRows()
def append_object(self, obj):
"""Append an object to this collection
:param obj: the object to be added to the collection
:return: the new number of rows in the collection
"""
rows = (self._rows or 0)
row = max(rows - 1, 0)
self._rows_about_to_be_inserted_signal.emit(row, row)
self.append(obj)
# defaults might depend on object being part of a collection
if not self.admin.is_persistent(obj):
self.unflushed_rows.add(row)
for depending_obj in self.admin.get_depending_objects(obj):
self.rsh.sendEntityUpdate(self, depending_obj)
self._rows = rows + 1
#
# update the cache, so the object can be retrieved
#
columns = self._columns
self._add_data(columns, rows, obj)
self._rows_inserted_signal.emit(row, row)
return self._rows
def get_admin(self):
"""Get the admin object associated with this model"""
return self.admin
