object_admin

Admin class for Plain Old Python Object

class camelot.admin.object_admin.FieldAttributesList(original_list)

A list with field attributes that documents them for sphinx

class camelot.admin.object_admin.ObjectAdmin(app_admin, entity)

The ObjectAdmin class describes the interface that will be used to interact with objects of a certain class. The behaviour of this class and the resulting interface can be tuned by specifying specific class attributes:

The name used in the GUI

The name used in the GUI for things like window titles and such can be specified using the verbose_name attribute.

verbose_name

A human-readable name for the object, singular

verbose_name = _('movie')

If this isn’t given, the class name will be used

verbose_name_plural

A human-readable name for the object, plural

verbose_name_plural = _('movies')

If this isn’t given, Camelot will use verbose_name + “s”

Fields displayed

list_display

a list with the fields that should be displayed in a table view

lines_per_row

An integer number specifying the height of a row in the table view, expressed as the number of lines of text it should be able to display. Defaults to 1.

form_display

a list with the fields that should be displayed in a form view, defaults to the same fields as those specified in list_display

class Admin(EntityAdmin):
    form_display = ['title', 'rating', 'cover']

instead of telling which fields to display. It is also possible to define the form itself

from camelot.view.forms import Form, TabForm, WidgetOnlyForm, HBoxForm

class Admin(EntityAdmin):
    form_display = TabForm([
    ('Movie', Form([
      HBoxForm([['title', 'rating'], WidgetOnlyForm('cover')]),
      'short_description',
      'releasedate',
      'director',
      'script',
      'genre',
      'description', 'tags'], scrollbars=True)),
    ('Cast', WidgetOnlyForm('cast'))
  ])

Behaviour

form_close_action

The action triggered when the form window is closed by the operating system or the window manager. By default this is the camelot.admin.action.form_action.CloseForm action, which validates the form and allows the user to discard the changes when the form is invalid. To change the form close action in the toolbar, the camelot.admin.object_admin.ObjectAdmin.get_form_actions() method should be overwritten.

save_mode

Specifies when the data should be send from the view to the model and flushed to the database. The default mode is ‘on_change’, meaning that every change in the view will be send immediately to the database. Other possibilities are :

• ‘on_leave’ : the data will be send from the view to the model when the view

  is closed, eg. : the form is closed.

delete_mode

Indicates if the deletion of an object should be confirmed by the user, defaults to ‘on_request’, indicating object should be deleted when the user hits the trash button. Other possibilities are :

• ‘on_confirm’ : the user will be asked for confirmation before the delete takes place.

form_size

a tuple indicating the size of a form view, defaults to (700,500)

form_actions

Actions to be accessible by pushbuttons on the side of a form, a list of camelot.admin.action.base.Action objects.

class Admin( EntityAdmin ):
    form_actions = [CloseForm()]

These actions will be triggered with a camelot.admin.action.form_action.FormActionModelContext as the model_context parameter in the camelot.admin.action.base.Action.model_run() method.

related_toolbar_actions

list of actions that appear in the toolbar of a OneToMany editor.

drop_action

the action that is triggered when a drag and drop occured on the table view

Field attributes

field_attributes

A dictionary specifying for each field of the model some additional attributes on how they should be displayed. All of these attributes are propagated to the constructor of the delegate of this field:

class Movie( Entity ):

    title = Column( Unicode(50) )

    class Admin( EntityAdmin ):
        list_display = ['title']
        field_attributes = { 'title' : {'editable':False} }

The Field Attributes documentation describes the various keys that can be used in the field attributes class attribute of an ObjectAdmin or EntityAdmin.

Window state

form_state

Set this attribute to maximized or minimized for respective behaviour

class Movie( Entity ):

    title = Column( Unicode(50) )

    class Admin( EntityAdmin ):
        list_display = ['title']
        form_state = 'maximized'

Varia

name

The name of the group in settings in which user dependent settings will be stored, defaults to the class name for which this Admin class is used.

class TableView(gui_context, admin, search_text=None, parent=None)

Parameters:

• gui_context – a camelot.admin.action.application_action.ApplicationActionGuiContext object.
• admin – an camelot.admin.entity_admin.EntityAdmin object
• search_text – a predefined search text to put in the search widget
• parent – a QtGui.QWidget object

A generic tableview widget that puts together some other widgets. The behaviour of this class and the resulting interface can be tuned by specifying specific class attributes which define the underlying widgets used

class MovieRentalTableView(TableView):
  title_format = 'Grand overview of recent movie rentals'

The attributes that can be specified are :

header_widget

The widget class to be used as a header in the table view:

header_widget = HeaderWidget

table_widget

The widget class used to display a table within the table view

table_widget = TableWidget

title_format

A string used to format the title of the view

title_format = ‘%(verbose_name_plural)s’

table_model

A class implementing QAbstractTableModel that will be used as a model for the table view

table_model = QueryTableProxy

• emits the row_selected signal when a row has been selected

class AdminTableWidget(admin, parent=None)

A table widget that inspects the admin class and changes the behavior of the table as specified in the admin class

ObjectAdmin.TableView.cancelSearch()

resets search filtering to default

ObjectAdmin.TableView.closeEvent(event)

reimplements close event

ObjectAdmin.TableView.create_table_model(admin)

Create a table model for the given admin interface

ObjectAdmin.TableView.getColumns()

return the columns to be displayed in the table view

ObjectAdmin.TableView.getTitle()

return the name of the entity managed by the admin attribute

ObjectAdmin.TableView.header_widget

alias of HeaderWidget

ObjectAdmin.TableView.rebuild_query()

resets the table model query

ObjectAdmin.TableView.refresh()

Refresh the whole view

ObjectAdmin.TableView.sectionClicked(section)

emits a row_selected signal

ObjectAdmin.TableView.selectTableRow(row)

selects the specified row

ObjectAdmin.TableView.set_admin(admin)

Switch to a different subclass, where admin is the admin object of the subclass

ObjectAdmin.TableView.set_filters_and_actions(filters_and_actions)

sets filters for the tableview

ObjectAdmin.TableView.startSearch(text)

rebuilds query based on filtering text

ObjectAdmin.TableView.table_model

alias of QueryTableProxy

ObjectAdmin.add(entity_instance)

Add an entity instance as a managed entity instance

ObjectAdmin.copy(*args, **kwargs)

Duplicate this entity instance

ObjectAdmin.create_form_view(title, model, index, parent=None)

Creates a Qt widget containing a form view, for a specific index in a model. Use this method to create a form view for a collection of objects, the user will be able to use PgUp/PgDown to move to the next object.

Parameters:

• title – the title of the form view
• model – the data model to be used to fill the form view
• index – which row in the data model to display
• parent – the parent widget for the form

ObjectAdmin.create_new_view(admin, related_collection_proxy=None, parent=None)

Create a Qt widget containing a form to create a new instance of the entity related to this admin class

The returned class has an ‘entity_created_signal’ that will be fired when a valid new entity was created by the form

Parameters:collection_proxy – if specified, the object will be appended to

its underlying collection upon creation and removed from it upon discarding.

ObjectAdmin.create_object_form_view(title, object_getter, parent=None)

Create a form view for a single object, PgUp/PgDown will do nothing.

Parameters:

• title – the title of the form view
• object_getter – a function taking no arguments, and returning the object
• parent – the parent widget for the form

ObjectAdmin.delete(entity_instance)

Delete an entity instance

ObjectAdmin.expunge(entity_instance)

Remove this object from the objects being managed

ObjectAdmin.flush(entity_instance)

Flush the pending changes of this entity instance to the backend

ObjectAdmin.get_all_fields_and_attributes(*args, **kwargs)

A dictionary of (field_name:field_attributes) for all fields that can possibly appear in a list or a form or for which field attributes have been defined

ObjectAdmin.get_application_admin()

Provide access to the ApplicationAdmin

Returns:the camelot.admin.application_admin.ApplicationAdmin object for the application.

ObjectAdmin.get_columns(*args, **kwargs)

The columns to be displayed in the list view, returns a list of pairs of the name of the field and its attributes needed to display it properly

@return: [(field_name,

{‘widget’: widget_type,

‘editable’: True or False, ‘blank’: True or False, ‘validator_list’:[...], ‘name’:’Field name’}),

...]

ObjectAdmin.get_compounding_objects(*args, **kwargs)

Overwrite this function to generate a list of objects out of which obj is build. These objects will be validated if obj is validated. The effect of returning compounding objects will be :

• obj will only be valid if all its compounding object are valid as well.
• default values will be set for the attributes of the compounding objects
• when an object is expired or refreshed, all its compounding objects will be expired and refreshed as well

ObjectAdmin.get_depending_objects(*args, **kwargs)

Overwrite this function to generate a list of objects that depend on a given object. When obj is modified by the user, this function will be called to determine which other objects need their views updated.

Parameters:obj – an object of the type that is managed by this admin class Returns:an iterator over objects that depend on obj

ObjectAdmin.get_dynamic_field_attributes(obj, field_names)

Convenience function to get all the field attributes that are dynamic (depend on the object being visualized). This method is called once for each object/row in a table view and once for each object being visualized in a form view.

Parameters:

• field_names – a list of field names
• obj – the object at the row for which to get the values of the dynamic field attributes

Returns:

[{field_attribute_name:field_attribute_value, ...}, {}, ...]

The returned list has the same order than the requested field_names. A reimplementation of this method can look like:

def get_dynamic_field_attributes(self, obj, field_names):
    for field_attributes in super( MyAdmin, self ).get_dynamic_field_attributes(obj, field_names):
        if obj.status == 'finished':
            field_attributes['editable'] = True
        else:
            field_attributes['editable'] = False
        yield field_attributes

ObjectAdmin.get_field_attributes(field_name)

Get the attributes needed to visualize the field field_name. This function is called by get_static_field_attributes and get_dynamic_field_attributes.

This function first tries to fill the dictionary with field attributes for a field with those gathered through introspection, and then updates them with those found in the field_attributes class attribute.

Parameters:field_name – the name of the field Returns:a dictionary of attributes needed to visualize the field

The values of the returned dictionary either contain the value of the field attribute, or in the case of dynamic field attributes, a function that returns the value of the field attribute.

ObjectAdmin.get_form_actions(*args, **kwargs)

Specify the list of action buttons that should appear on the side of the form view.

Parameters:obj – the object displayed in the form Returns:a list of camelot.admin.action.base.Action objects

ObjectAdmin.get_form_toolbar_actions(*args, **kwargs)

By default this function will return the same as camelot.admin.application_admin.ApplicationAdmin.get_form_toolbar_actions()

Parameters:toolbar_area – an instance of Qt.ToolBarArea indicating where the toolbar actions will be positioned Returns:a list of camelot.admin.action.base.Action objects that should be displayed on the toolbar of a form view. return None if no toolbar should be created.

ObjectAdmin.get_modifications(obj)

Get the modifications on an object since the last flush. :param obj: the object for which to get the modifications :return: a dictionary with the changed attributes and their old

value

ObjectAdmin.get_name()

The name of the group in settings in which user dependent settings will be stored, this is either the name attribute of this class or, the class name of the class for which this Admin class is used.

Returns:a string with the name of the settings group

ObjectAdmin.get_related_admin(cls)

Get an admin object for another object class. Taking into account preferences of this admin object or for those of admin object higher up the chain such as the application admin object.

Parameters:cls – the class for which an admin object is requested

ObjectAdmin.get_related_toolbar_actions(toolbar_area, direction)

Specify the toolbar actions that should appear in a OneToMany editor.

Parameters:

• toolbar_area – the position of the toolbar
• direction – the direction of the relation : ‘onetomany’ or ‘manytomany’

Returns:

a list of camelot.admin.action.base.Action objects

ObjectAdmin.get_settings()

A settings object in which settings related to this admin can be stored.

Returns:a QtCore.QSettings object

ObjectAdmin.get_static_field_attributes(field_names)

Convenience function to get all the field attributes that are static (don’t depend on the object being visualized). This method is only called once for a table or form view, independent of the number of objects/records being visualized.

Parameters:field_names – a list of field names Returns:[{field_attribute_name:field_attribute_value, ...}, {}, ...]

The returned list has the same order than the requested field_names.

ObjectAdmin.get_subclass_tree(*args, **kwargs)

Get a tree of admin classes representing the subclasses of the class represented by this admin class

Returns:[(subclass_admin, [(subsubclass_admin, [...]),...]),...]

ObjectAdmin.get_table()

The definition of the table to be used in a list view :return: a camelot.admin.table.Table object

ObjectAdmin.get_validator(model=None, initial_validation=False)

Get a validator object

Returns:a camelot.admin.validator.object_validator.Validator

ObjectAdmin.get_verbose_identifier(*args, **kwargs)

Create an identifier for an object that is interpretable for the user, eg : the primary key of an object. This verbose identifier can be used to generate a title for a form view of an object.

ObjectAdmin.is_deleted(_obj)

Returns:True if the object has been deleted from the persistent

state, False otherwise

ObjectAdmin.is_persistent(_obj)

Returns:True if the object has a persisted state, False otherwise

ObjectAdmin.model

alias of CollectionProxy

ObjectAdmin.primary_key(obj)

Get the primary key of an object :param obj: the object to get the primary key from :return: a tuple with with components of the primary key, or an

emtpy list if the object has no primary key yet or any more.

ObjectAdmin.refresh(entity_instance)

Undo the pending changes to the backend and restore the original state

ObjectAdmin.set_defaults(object_instance, include_nullable_fields=True)

Set the defaults of an object :param include_nullable_fields: also set defaults for nullable fields, depending on the context, this should be set to False to allow the user to set the field to None

ObjectAdmin.validator

alias of ObjectValidator