core.prototypes.list

Module Contents

Classes

List

List is a ViUR BasicApplication.

class core.prototypes.list.List(moduleName, modulePath, *args, **kwargs)

Bases: viur.core.prototypes.BasicApplication

List is a ViUR BasicApplication.

It is used for multiple data entities of the same kind, and needs to be sub-classed for individual modules.

Variables
  • kindName (str) – Name of the kind of data entities that are managed by the application. This information is used to bind a specific server.skeleton.Skeleton-class to the application. For more information, refer to the function _resolveSkel().

  • adminInfo (dict | callable) – todo short info on how to use adminInfo.

accessRights = ['add', 'edit', 'view', 'delete']
adminInfo(self)
viewSkel(self, *args, **kwargs)

Retrieve a new instance of a server.skeleton.Skeleton that is used by the application for viewing an existing entry from the list.

The default is a Skeleton instance returned by _resolveSkel().

See also

addSkel(), editSkel(), _resolveSkel()

Returns

Returns a Skeleton instance for viewing an entry.

Return type

server.skeleton.Skeleton

addSkel(self, *args, **kwargs)

Retrieve a new instance of a server.skeleton.Skeleton that is used by the application for adding an entry to the list.

The default is a Skeleton instance returned by _resolveSkel().

See also

viewSkel(), editSkel(), _resolveSkel()

Returns

Returns a Skeleton instance for adding an entry.

Return type

server.skeleton.Skeleton

editSkel(self, *args, **kwargs)

Retrieve a new instance of a server.skeleton.Skeleton that is used by the application for editing an existing entry from the list.

The default is a Skeleton instance returned by _resolveSkel().

See also

viewSkel(), editSkel(), _resolveSkel()

Returns

Returns a Skeleton instance for editing an entry.

Return type

server.skeleton.Skeleton

preview(self, skey, *args, **kwargs)

Renders data for an entry, without reading from the database. This function allows to preview an entry without writing it to the database.

Any entity values are provided via kwargs.

The function uses the viewTemplate of the application.

Returns

The rendered representation of the the supplied data.

structure(self, *args, **kwargs)
Returns

Returns the structure of our skeleton as used in list/view. Values are the defaultValues set in each bone.

Raises

viur.core.errors.Unauthorized, if the current user does not have the required permissions.

view(self, *args, **kwargs)

Prepares and renders a single entry for viewing.

The entry is fetched by its entity key, which either is provided via kwargs[“key”], or as the first parameter in args. The function performs several access control checks on the requested entity before it is rendered.

Returns

The rendered representation of the requested entity.

Raises

server.errors.NotAcceptable, when no key is provided.

Raises

server.errors.NotFound, when no entry with the given key was found.

Raises

server.errors.Unauthorized, if the current user does not have the required permissions.

list(self, *args, **kwargs)

Prepares and renders a list of entries.

All supplied parameters are interpreted as filters for the elements displayed.

Unlike other ViUR BasicApplications, the access control in this function is performed by calling the function listFilter(), which updates the query-filter to match only elements which the user is allowed to see.

See also

listFilter(), server.db.mergeExternalFilter()

Returns

The rendered list objects for the matching entries.

Raises

server.errors.Unauthorized, if the current user does not have the required permissions.

edit(self, *args, **kwargs)

Modify an existing entry, and render the entry, eventually with error notes on incorrect data. Data is taken by any other arguments in kwargs.

The entry is fetched by its entity key, which either is provided via kwargs[“key”], or as the first parameter in args. The function performs several access control checks on the requested entity before it is modified.

Returns

The rendered, edited object of the entry, eventually with error hints.

Raises

server.errors.NotAcceptable, when no key is provided.

Raises

server.errors.NotFound, when no entry with the given key was found.

Raises

server.errors.Unauthorized, if the current user does not have the required permissions.

Raises

server.errors.PreconditionFailed, if the skey could not be verified.

add(self, *args, **kwargs)

Add a new entry, and render the entry, eventually with error notes on incorrect data. Data is taken by any other arguments in kwargs.

The function performs several access control checks on the requested entity before it is added.

Returns

The rendered, added object of the entry, eventually with error hints.

Raises

server.errors.Unauthorized, if the current user does not have the required permissions.

Raises

server.errors.PreconditionFailed, if the skey could not be verified.

delete(self, key, skey, *args, **kwargs)

Delete an entry.

The function runs several access control checks on the data before it is deleted.

Returns

The rendered, deleted object of the entry.

Raises

server.errors.NotFound, when no entry with the given key was found.

Raises

server.errors.Unauthorized, if the current user does not have the required permissions.

Raises

server.errors.PreconditionFailed, if the skey could not be verified.

index(self, *args, **kwargs)

Default, SEO-Friendly fallback for view and list.

Parameters
  • args

  • kwargs

Returns

getDefaultListParams(self)
listFilter(self, filter)

Access control function on item listing.

This function is invoked by the list() renderer and the related Jinja2 fetching function, and is used to modify the provided filter parameter to match only items that the current user is allowed to see.

Parameters

filter (server.db.Query) – Query which should be altered.

Returns

The altered filter, or None if access is not granted.

canView(self, skel: viur.core.skeleton.SkeletonInstance)bool

Checks if the current user can view the given entry. Should be identical to what’s allowed by listFilter. By default, meth:listFilter is used to determine what’s allowed and whats not; but this method can be overridden for performance improvements (to eliminate that additional database access). :param skel: The entry we check for :return: True if the current session is authorized to view that entry, False otherwise

canAdd(self)

Access control function for adding permission.

Checks if the current user has the permission to add a new entry.

The default behavior is: - If no user is logged in, adding is generally refused. - If the user has “root” access, adding is generally allowed. - If the user has the modules “add” permission (module-add) enabled, adding is allowed.

It should be overridden for a module-specific behavior.

See also

add()

Returns

True, if adding entries is allowed, False otherwise.

Return type

bool

canPreview(self)

Access control function for preview permission.

Checks if the current user has the permission to preview an entry.

The default behavior is: - If no user is logged in, previewing is generally refused. - If the user has “root” access, previewing is generally allowed. - If the user has the modules “add” or “edit” permission (module-add, module-edit) enabled, previewing is allowed.

It should be overridden for module-specific behavior.

See also

preview()

Returns

True, if previewing entries is allowed, False otherwise.

Return type

bool

canEdit(self, skel: viur.core.skeleton.SkeletonInstance)

Access control function for modification permission.

Checks if the current user has the permission to edit an entry.

The default behavior is: - If no user is logged in, editing is generally refused. - If the user has “root” access, editing is generally allowed. - If the user has the modules “edit” permission (module-edit) enabled, editing is allowed.

It should be overridden for a module-specific behavior.

See also

edit()

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that should be edited.

Returns

True, if editing entries is allowed, False otherwise.

Return type

bool

canDelete(self, skel: viur.core.skeleton.SkeletonInstance)bool

Access control function for delete permission.

Checks if the current user has the permission to delete an entry.

The default behavior is: - If no user is logged in, deleting is generally refused. - If the user has “root” access, deleting is generally allowed. - If the user has the modules “deleting” permission (module-delete) enabled, deleting is allowed.

It should be overridden for a module-specific behavior.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that should be deleted.

See also

delete()

Returns

True, if deleting entries is allowed, False otherwise.

Return type

bool

onAdd(self, skel: viur.core.skeleton.SkeletonInstance)

Hook function that is called before adding an entry.

It can be overridden for a module-specific behavior.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that is going to be added.

See also

add(), onAdded()

onAdded(self, skel: viur.core.skeleton.SkeletonInstance)

Hook function that is called after adding an entry.

It should be overridden for a module-specific behavior. The default is writing a log entry.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that has been added.

See also

add(), , onAdd()

onEdit(self, skel: viur.core.skeleton.SkeletonInstance)

Hook function that is called before editing an entry.

It can be overridden for a module-specific behavior.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that is going to be edited.

See also

edit(), onEdited()

onEdited(self, skel: viur.core.skeleton.SkeletonInstance)

Hook function that is called after modifying an entry.

It should be overridden for a module-specific behavior. The default is writing a log entry.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that has been modified.

See also

edit(), onEdit()

onView(self, skel: viur.core.skeleton.SkeletonInstance)

Hook function that is called when viewing an entry.

It should be overridden for a module-specific behavior. The default is doing nothing.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that is viewed.

See also

view()

onDelete(self, skel: viur.core.skeleton.SkeletonInstance)

Hook function that is called before deleting an entry.

It can be overridden for a module-specific behavior.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that is going to be deleted.

See also

delete(), onDeleted()

onDeleted(self, skel: viur.core.skeleton.SkeletonInstance)

Hook function that is called after deleting an entry.

It should be overridden for a module-specific behavior. The default is writing a log entry.

Parameters

skel (server.skeleton.Skeleton) – The Skeleton that has been deleted.

See also

delete(), onDelete()

core.prototypes.list.admin = True
core.prototypes.list.html = True
core.prototypes.list.vi = True