Previous topic

stalker.core.models.entity.SimpleEntity

Next topic

stalker.core.models.entity.TypeEntity

This Page

stalker.core.models.entity.Entity

Inheritance diagram of stalker.core.models.entity.Entity

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

Bases: stalker.core.models.entity.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 – 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 – a list of note objects. notes can be an empty list, or when omitted it will be set to an empty list
__init__(tags=[], notes=[], **kwargs)[source]

Methods

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

Attributes

code
created_by gets and sets the User object who has created this
date_created gets and sets the datetime.datetime object which shows when
date_updated gets and sets the datetime.datetime object which shows when
description the description of the entity
name the name of the entity
nice_name this is the nice name of the SimpleEntity. It has the same
notes all the notes about this entity, it should be a list of Notes
tags a list of Tag objects which shows the related tags to the
updated_by gets and sets the User object who has updated this
created_by

gets and sets the User object who has created this AuditEntity

date_created

gets and sets the datetime.datetime object which shows when this object has been created

date_updated

gets and sets the datetime.datetime object which shows when this object has been updated

description

the description of the entity

name

the name of the entity

nice_name

this is the nice name of the SimpleEntity. It has the same value with the name (contextually) but with a different format like, all the whitespaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lowercase.

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

updated_by

gets and sets the User object who has updated this AuditEntity

notes[source]

all the notes about this entity, it should be a list of Notes objects or an empty list, None is not accepted

tags[source]

a list of Tag objects which shows the related tags to the entity