Previous topic

stalker.core.models.comment

Next topic

stalker.core.models.department

This Page

stalker.core.models.comment.Comment

Inheritance diagram of stalker.core.models.comment.Comment

class stalker.core.models.comment.Comment(body='', to=None, **kwargs)[source]

Bases: stalker.core.models.entity.Entity

User reviews and comments about other entities.

Parameters:
  • body – the body of the comment, it is a string or unicode variable, it can be empty but it is then meaningles to have an empty comment. Anything other than a string or unicode will raise a ValueError.
  • to – the relation variable, that holds the connection that this comment is related to. it should be an Entity object, any other will raise a ValueError
__init__(body='', to=None, **kwargs)[source]

Methods

__init__(**kwargs[, body, to])

Attributes

body this is the property that sets and returns the body attribute
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
to this is the property that sets and returns the to attribute
updated_by gets and sets the User object who has updated this
body[source]

this is the property that sets and returns the body attribute

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

notes

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

tags

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

updated_by

gets and sets the User object who has updated this AuditEntity

to[source]

this is the property that sets and returns the to attribute