shuup.tasks package

Subpackages

• shuup.tasks.admin_module package
  • Subpackages
    • shuup.tasks.admin_module.views package
      • Submodules
      • shuup.tasks.admin_module.views.edit module
      • shuup.tasks.admin_module.views.list module
      • Module contents
  • Module contents

Submodules

shuup.tasks.apps module

class shuup.tasks.apps.AppConfig(*args, **kwargs)

Bases: shuup.apps.AppConfig

name = 'shuup.tasks'

label = 'shuup_tasks'

provides = {'admin_module': ['shuup.tasks.admin_module.TaskAdminModule', 'shuup.tasks.admin_module.TaskTypeAdminModule']}

shuup.tasks.models module

class shuup.tasks.models.TaskStatus

Bases: enumfields.enums.Enum

An enumeration.

NEW = 1

IN_PROGRESS = 2

COMPLETED = 3

DELETED = 4

class shuup.tasks.models.TaskCommentVisibility

Bases: enumfields.enums.Enum

An enumeration.

PUBLIC = 1

STAFF_ONLY = 2

ADMINS_ONLY = 3

class shuup.tasks.models.TaskType(id, identifier, shop)

Bases: parler.models.TranslatableModel

Parameters:

• id (AutoField) – Id
• identifier (InternalIdentifierField) – Do not change this value if you are not sure what you are doing.
• shop (ForeignKey to shuup.core.models.Shop) – Shop
• name (TextField) – (Translatable) Name

translations

ManyToOneRel to shuup.tasks.models.TaskTypeTranslation

tasks

ManyToOneRel to shuup.tasks.models.Task

identifier

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

shop

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

translations

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name

Descriptor for translated attributes.

This attribute proxies all get/set calls to the translated model.

shop_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tasks

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class shuup.tasks.models.TaskQuerySet(model=None, query=None, using=None, hints=None)

Bases: django.db.models.query.QuerySet

completed()

in_progress()

is_new()

for_shop(shop)

delete()

assigned_to(contact)

class shuup.tasks.models.Task(id, shop, name, type, status, priority, creator, assigned_to, completed_by, completed_on, created_on, modified_on)

Bases: django.db.models.base.Model

Parameters:

• id (AutoField) – Id
• shop (ForeignKey to shuup.core.models.Shop) – Shop
• name (CharField) – Name
• type (ForeignKey to shuup.tasks.models.TaskType) – Task type
• status (EnumIntegerField) – Status
• priority (PositiveIntegerField) – Priority
• creator (ForeignKey to shuup.core.models.Contact) – Creator
• assigned_to (ForeignKey to shuup.core.models.Contact) – Assigned to
• completed_by (ForeignKey to shuup.core.models.Contact) – Completed by
• completed_on (DateTimeField) – Completed on
• created_on (DateTimeField) – Created on
• modified_on (DateTimeField) – Modified on

comments

ManyToOneRel to shuup.tasks.models.TaskComment

log_entries

ManyToOneRel to shuup.tasks.models.TaskLogEntry

shop

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

type

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

status

A property descriptor which ensures that field.to_python() is called on _every_ assignment to the field.

This used to be provided by the django.db.models.subclassing.Creator class, which in turn was used by the deprecated-in-Django-1.10 SubfieldBase class, hence the reimplementation here.

priority

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

creator

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

assigned_to

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

completed_by

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

completed_on

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created_on

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

modified_on

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.ManagerFromTaskQuerySet object>

assign(user)

delete()

comment(contact, comment, visibility=<TaskCommentVisibility.PUBLIC: 1>)

set_in_progress()

set_completed(contact)

get_completion_time()

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

add_log_entry(message, identifier=None, kind=<LogEntryKind.OTHER: 0>, user=None, extra=None, save=True)

assigned_to_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

comments

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

completed_by_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

creator_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_created_on(*, field=<django.db.models.fields.DateTimeField: created_on>, is_next=True, **kwargs)

get_next_by_modified_on(*, field=<django.db.models.fields.DateTimeField: modified_on>, is_next=True, **kwargs)

get_previous_by_created_on(*, field=<django.db.models.fields.DateTimeField: created_on>, is_next=False, **kwargs)

get_previous_by_modified_on(*, field=<django.db.models.fields.DateTimeField: modified_on>, is_next=False, **kwargs)

get_status_display(*, field=<enumfields.fields.EnumIntegerField: status>)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

log_entries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

shop_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

type_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class shuup.tasks.models.TaskCommentQuerySet(model=None, query=None, using=None, hints=None)

Bases: django.db.models.query.QuerySet

for_contact(contact)

class shuup.tasks.models.TaskComment(id, task, author, visibility, body, created_on, modified_on)

Bases: django.db.models.base.Model

Parameters:

• id (AutoField) – Id
• task (ForeignKey to shuup.tasks.models.Task) – Task
• author (ForeignKey to shuup.core.models.Contact) – Author
• visibility (EnumIntegerField) – Visibility
• body (TextField) – Body
• created_on (DateTimeField) – Created on
• modified_on (DateTimeField) – Modified on

task

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

author

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

visibility

A property descriptor which ensures that field.to_python() is called on _every_ assignment to the field.

This used to be provided by the django.db.models.subclassing.Creator class, which in turn was used by the deprecated-in-Django-1.10 SubfieldBase class, hence the reimplementation here.

body

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created_on

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

modified_on

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.ManagerFromTaskCommentQuerySet object>

reply(contact, body)

as_html()

can_see(user)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

author_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_created_on(*, field=<django.db.models.fields.DateTimeField: created_on>, is_next=True, **kwargs)

get_next_by_modified_on(*, field=<django.db.models.fields.DateTimeField: modified_on>, is_next=True, **kwargs)

get_previous_by_created_on(*, field=<django.db.models.fields.DateTimeField: created_on>, is_next=False, **kwargs)

get_previous_by_modified_on(*, field=<django.db.models.fields.DateTimeField: modified_on>, is_next=False, **kwargs)

get_visibility_display(*, field=<enumfields.fields.EnumIntegerField: visibility>)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

task_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class shuup.tasks.models.TaskLogEntry(id, created_on, user, message, identifier, kind, extra, target)

Bases: shuup.utils.analog.BaseLogEntry

Parameters:

• id (AutoField) – Id
• created_on (DateTimeField) – Created on
• user (ForeignKey to django.contrib.auth.models.User) – User
• message (CharField) – Message
• identifier (CharField) – Identifier
• kind (EnumIntegerField) – Log entry kind
• extra (JSONField) – Extra data
• target (ForeignKey to shuup.tasks.models.Task) – Target

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

extra

A placeholder class that provides a way to set the attribute on the model.

get_next_by_created_on(*, field=<django.db.models.fields.DateTimeField: created_on>, is_next=True, **kwargs)

get_previous_by_created_on(*, field=<django.db.models.fields.DateTimeField: created_on>, is_next=False, **kwargs)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

kind

A property descriptor which ensures that field.to_python() is called on _every_ assignment to the field.

This used to be provided by the django.db.models.subclassing.Creator class, which in turn was used by the deprecated-in-Django-1.10 SubfieldBase class, hence the reimplementation here.

logged_model

alias of Task

objects = <django.db.models.manager.Manager object>

target

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

target_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

class shuup.tasks.models.TaskTypeTranslation(id, language_code, name, master)

Bases: parler.models.TranslatedFieldsModel

Parameters:

• id (AutoField) – Id
• language_code (HideChoicesCharField) – Language
• name (TextField) – Name
• master (TranslationsForeignKey to shuup.tasks.models.TaskType) – Master

exception DoesNotExist

Bases: parler.models.TranslationDoesNotExist, shuup.tasks.models.DoesNotExist, shuup.tasks.models.DoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

master

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

master_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

shuup.tasks.utils module

shuup.tasks.utils.create_task(shop, creator, task_type, task_name, comment=None, **kwargs)

Module contents