Previous topic

stalker.core.models.department

Next topic

stalker.core.models.entity

This Page

stalker.core.models.department.Department

Inheritance diagram of stalker.core.models.department.Department

class stalker.core.models.department.Department(members=[], lead=None, **kwargs)[source]

Bases: stalker.core.models.entity.Entity

The departments that forms the studio itself.

The informations that a Department object holds is like:

  • The members of the department
  • The lead of the department
  • and all the other things those are inherited from the AuditEntity class

Two Department object considered the same if they have the same name, the the members list nor the lead info is important, a “Modeling” department should of course be the same with another department which has the name “Modeling” again.

so creating a department object needs the following parameters:

Parameters:
  • members – it can be an empty list, so one department can be created without any member in it. But this parameter should be a list of User objects.
  • lead – this is a User object, that holds the lead information, a lead could be in this department but it is not forced to be also a member of the department. So another departments member can be a lead for another department. Lead attribute can not be empty or None.
__init__(members=[], lead=None, **kwargs)[source]

Methods

__init__(**kwargs[, members, lead])

Attributes

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.
lead lead is the lead of this department, it is a User object
members members are a list of users representing the members of this
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
updated_by The User who has updated
members[source]

members are a list of users representing the members of this department

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.

lead[source]

lead is the lead of this department, it is a User 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.