Previous topic

stalker.core.models.Task

Next topic

stalker.core.models.User

This Page

stalker.core.models.Type

Inheritance diagram of stalker.core.models.Type

class stalker.core.models.Type(target_entity_type=None, **kwargs)[source]

Bases: stalker.core.models.Entity

Everything can have a type.

New in version 0.1.1: Types

Type is a generalized version of the previous design that defines types for specific classes.

The purpose of the Type class is just to define a new type for a specific Entity. For example, you can have a Character Asset or you can have a Commercial Project or you can define a Link as an Image etc., to create a new Type for various classes:

Type(name="Character", target_entity_type="Asset")
Type(name="Commercial", target_entity_type="Project")
Type(name="Image", target_entity_type="Link")

or:

Type(name="Character", target_entity_type=Asset.entity_type)
Type(name="Commercial", target_entity_type=Project.entity_type)
Type(name="Image", target_entity_type=Link.entity_type)

or even better:

Type(name=”Character”, target_entity_type=Asset) Type(name=”Commercial”, target_entity_type=Project) Type(name=”Image”, target_entity_type=Link)

By using Types, one can able to sort and group same type of entities.

Types are generally used in Structures.

Parameters:target_entity_type (string) – The string defining the target type of this Type.
__init__(target_entity_type=None, **kwargs)[source]

Methods

__init__(**kwargs[, target_entity_type])

Attributes

code The code name of this object.
created_by The User who has created this object.
date_created A datetime.datetime instance showing the creation date and time of this object.
date_updated A datetime.datetime instance showing the update date and time of this object.
description Description of this object.
name Name of this object
nice_name Nice name of this object.
notes All the notes about this entity.
tags A list of tags attached to this object.
target_entity_type The target type of this Type instance.
type The type of the object.
updated_by The User who has updated this object.
target_entity_type[source]

The target type of this Type instance.

It is a string, showing the name of the target type class. It is a read-only attribute.

code

The code name of this object.

It accepts string or unicode values and any other kind of objects will be converted to string. In any update to the name attribute the code also will be updated. If the code is not initialized or given as None, it will be set to the uppercase version of the nice_name attribute. Setting the code attribute to None will reset it to the default value. The default value is the upper case form of the nice_name.

created_by

The User who has created this object.

date_created

A datetime.datetime instance showing the creation date and time of this object.

date_updated

A datetime.datetime instance showing the update date and time of this object.

description

Description of this object.

name

Name of this object

nice_name

Nice name of this object.

It has the same value with the name (contextually) but with a different format like, all the white spaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lower case.

There is also the code attribute which is simply the upper case form of nice_name if it is not defined differently (i.e set to another value).

notes

All the notes about this entity.

It is a list of Note objects or an empty list, None will be converted to an empty list.

tags

A list of tags attached to this object.

It is a list of Tag instances which shows the tags of this object

type

The type of the object.

It is an instance of Type with a proper target_entity_type.

updated_by

The User who has updated this object.