magpie.models

Module Contents

Classes

Group	Mixin for Group model
GroupPermission	Mixin for GroupPermission model
UserGroup	Mixin for UserGroup model
GroupResourcePermission	Mixin for GroupResourcePermission model
Resource	Mixin for Resource model
UserPermission	Mixin for UserPermission model
UserResourcePermission	Mixin for UserResourcePermission model
User	Base mixin for User object representation.
ExternalIdentity	Mixin for External Identity model - it represents oAuth(or other) accounts
RootFactory	Used to build base Access Control List (ACL) of the request user.
UserFactory	Used to build base Access Control List (ACL) of the request user.
Service	Resource of service type.
PathBase
File	Mixin for Resource model
Directory	Mixin for Resource model
Workspace	Mixin for Resource model
Route	Mixin for Resource model
RemoteResource	Basic class that all other classes inherit from that supplies some
RemoteResourcesSyncInfo	Basic class that all other classes inherit from that supplies some
RemoteResourceTreeService	Initialize self. See help(type(self)) for accurate signature.
RemoteResourceTreeServicePostgresSQL	This is necessary, because ResourceTreeServicePostgresSQL.model is the Resource class. If we want to change it for a

Functions

get_session_callable(request)
resource_factory(**kwargs)
find_children_by_name(child_name, parent_id, db_session)

magpie.models.Base

magpie.models.get_session_callable(request)

class magpie.models.Group

Bases: ziggurat_foundations.models.group.GroupMixin, Base

Mixin for Group model

get_member_count(self, db_session=None)

property discoverable(self)

Indicates if the group is discoverable for users to self-register to it.

class magpie.models.GroupPermission

Bases: ziggurat_foundations.models.group_permission.GroupPermissionMixin, Base

Mixin for GroupPermission model

class magpie.models.UserGroup

Bases: ziggurat_foundations.models.user_group.UserGroupMixin, Base

Mixin for UserGroup model

class magpie.models.GroupResourcePermission

Bases: ziggurat_foundations.models.group_resource_permission.GroupResourcePermissionMixin, Base

Mixin for GroupResourcePermission model

class magpie.models.Resource

Bases: ziggurat_foundations.models.resource.ResourceMixin, Base

Mixin for Resource model

resource_type_name :Str

child_resource_allowed = True

resource_display_name

property root_service_id(self)

property __acl__(self)

User or group that owns a resource are granted full access to it.

class magpie.models.UserPermission

Bases: ziggurat_foundations.models.user_permission.UserPermissionMixin, Base

Mixin for UserPermission model

class magpie.models.UserResourcePermission

Bases: ziggurat_foundations.models.user_resource_permission.UserResourcePermissionMixin, Base

Mixin for UserResourcePermission model

class magpie.models.User

Bases: ziggurat_foundations.models.user.UserMixin, Base

Base mixin for User object representation. It supplies all the basic functionality from password hash generation and matching to utility methods used for querying database for users and their permissions or resources they have access to. It is meant to be extended with other application specific properties

__str__(self)

Return str(self).

class magpie.models.ExternalIdentity

Bases: ziggurat_foundations.models.external_identity.ExternalIdentityMixin, Base

Mixin for External Identity model - it represents oAuth(or other) accounts attached to your user object

class magpie.models.RootFactory(request)

Bases: object

Used to build base Access Control List (ACL) of the request user.

All API and UI routes will employ this set of effective principals to determine if the user is authorized to access the pyramid view according to the permission value it was configured with.

Note

Keep in mind that Magpie is configured with default permission magpie.constants.MAGPIE_ADMIN_PERMISSION. Views that require more permissive authorization must be overridden with permission argument.

See also

• set_default_permission within magpie.includeme() initialization steps

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

__name__

__parent__ =

property __acl__(self)

Administrators have all permissions, user/group-specific permissions added if user is logged in.

class magpie.models.UserFactory(request)

Bases: magpie.models.RootFactory

Used to build base Access Control List (ACL) of the request user.

All API and UI routes will employ this set of effective principals to determine if the user is authorized to access the pyramid view according to the permission value it was configured with.

Note

Keep in mind that Magpie is configured with default permission magpie.constants.MAGPIE_ADMIN_PERMISSION. Views that require more permissive authorization must be overridden with permission argument.

See also

• set_default_permission within magpie.includeme() initialization steps

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

__getitem__(self, user_name)

property __acl__(self)

Grant access to request user according to its relationship to context user (targeted by request path variable).

If it is the same user (either from explicit name or magpie.constants.MAGPIE_LOGGED_USER reserved keyword), allow magpie.constants.MAGPIE_LOGGED_PERMISSION for itself to access corresponding views.

If request user is unauthenticated, magpie.constants.MAGPIE_LOGGED_USER or itself, also grant magpie.constants.MAGPIE_CONTEXT_PERMISSION to allow access to contextually-available details. (e.g.: user can view his own information and public ones)

class magpie.models.Service

Bases: magpie.models.Resource

Resource of service type.

__tablename__ = services

resource_id

resource_type_name = service

__mapper_args__

property permissions(self)

property url(self)

property type(self)

Identifier matching magpie.services.ServiceInterface.service_type.

property sync_type(self)

Identifier matching magpie.cli.SyncServiceInterface.sync_type.

static by_service_name(service_name, db_session)

class magpie.models.PathBase

Bases: object

permissions

class magpie.models.File

Bases: magpie.models.Resource, magpie.models.PathBase

Mixin for Resource model

child_resource_allowed = False

resource_type_name = file

__mapper_args__

class magpie.models.Directory

Bases: magpie.models.Resource, magpie.models.PathBase

Mixin for Resource model

resource_type_name = directory

__mapper_args__

class magpie.models.Workspace

Bases: magpie.models.Resource

Mixin for Resource model

resource_type_name = workspace

__mapper_args__

permissions

class magpie.models.Route

Bases: magpie.models.Resource

Mixin for Resource model

resource_type_name = route

__mapper_args__

permissions

class magpie.models.RemoteResource

Bases: ziggurat_foundations.models.base.BaseModel, Base

Basic class that all other classes inherit from that supplies some basic methods useful for interaction with packages like: deform, colander or wtforms

__tablename__ = remote_resources

__possible_permissions__ = []

_ziggurat_services

resource_id

service_id

parent_id

ordering

resource_name

resource_display_name

resource_type

__repr__(self)

Return repr(self).

class magpie.models.RemoteResourcesSyncInfo

Bases: ziggurat_foundations.models.base.BaseModel, Base

Basic class that all other classes inherit from that supplies some basic methods useful for interaction with packages like: deform, colander or wtforms

__tablename__ = remote_resources_sync_info

id

service_id

service

remote_resource_id

last_sync

static by_service_id(service_id, session)

__repr__(self)

Return repr(self).

class magpie.models.RemoteResourceTreeService(service_cls)

Bases: ziggurat_foundations.models.services.resource_tree.ResourceTreeService

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

class magpie.models.RemoteResourceTreeServicePostgresSQL

Bases: ziggurat_foundations.models.services.resource_tree_postgres.ResourceTreeServicePostgreSQL

This is necessary, because ResourceTreeServicePostgresSQL.model is the Resource class. If we want to change it for a RemoteResource, we need this class.

The ResourceTreeService.__init__ call sets the model.

magpie.models.RESOURCE_TREE_SERVICE

magpie.models.REMOTE_RESOURCE_TREE_SERVICE

magpie.models.RESOURCE_TYPE_DICT :Dict[Str, Type[Resource]]

magpie.models.resource_factory(**kwargs)

magpie.models.find_children_by_name(child_name, parent_id, db_session)