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 The code name of this object.
created_by The User who has created
date_created A datetime.datetime instance showing the creation
date_updated A datetime.datetime instance showing the update
description Description of this object.
name name of this object
nice_name The nice name of this object.
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 The User who has updated
body[source]

this is the property that sets and returns the body 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 to the uppercase form of the nice_name attribute. If the 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

The 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 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

The User who has updated this object.

to[source]

this is the property that sets and returns the to attribute