Previous topic

stalker.core.models.FilenameTemplate

Next topic

stalker.core.models.ImageFormat

This Page

stalker.core.models.Entity

Inheritance diagram of stalker.core.models.Entity

class stalker.core.models.Entity(tags=[], notes=[], **kwargs)[source]

Bases: stalker.core.models.SimpleEntity

Another base data class that adds tags and notes to the attributes list.

This is the entity class which is derived from the SimpleEntity and adds only tags to the list of parameters.

Two Entities considered equal if they have the same name. It doesn’t matter if they have different tags or notes.

Parameters:
  • tags (list) – A list of Tag objects related to this entity. tags could be an empty list, or when omitted it will be set to an empty list.
  • notes (list) – A list of Note instances. Can be an empty list, or when omitted it will be set to an empty list, when set to None it will be converted to an empty list.
__init__(tags=[], notes=[], **kwargs)[source]

Methods

__init__(**kwargs[, tags, notes])

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.
type The type of the object.
updated_by The User who has updated this object.
notes[source]

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[source]

A list of tags attached to this object.

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

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).

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.