Class Workroom

workroom(studio)

level = ‘studio’

редактирование отделов

Данные хранимые в БД (имя столбца : тип данных):

workroom_keys = {
'name': 'text',
'id': 'text',
'type': 'json' # список типов задач, которые выполняются данным отделом.
}

Создание экземпляра класса:

import edit_db as db

workroom = db.workroom()

Атрибуты

name:(str) - имя отдела (уникально). id:(str) - hex type:(json) - список типов задач из studio.task_types, которые выполняются данным отделом. list_workroom:(list) - атрибут класса список отделов даной студии (экземпляры). Заполняется привыполнеии метода get_list, значение по умолчанию - []. dict_by_name:(dict) - атрибут класса словарь отделов даной студии (экземпляры) с ключами по именам. Заполняется привыполнеии метода get_list, значение по умолчанию - {}. dict_by_id:(dict) - атрибут класса словарь отделов даной студии (экземпляры) с ключами по id. Заполняется привыполнеии метода get_list, значение по умолчанию - {}.

Методы

init_by_keys(keys[, new = True])

заполнение полей экземпляра по ключам из keys, если new=True - то возвращает новый экземпляр.

Параметры:

• keys (dict) - словарь по workroom_keys
• new (bool) - если True - то возвращается новый инициализированный экземпляр класса workroom, если False - то инициализируется текущий экземпляр
• return - (True, ‘Ok!’) / workroom - новый инициализированный экземпляр, или (False, comment)

add(keys[, new=False])

создание отдела.

Параметры:

• keys (dict) - словарь ключей по workroom_keys, name - обязательный параметр.
• new (bool) - если True - то возвращает инициализированный экземпляр.
• return - (True, ‘Ok!’) / workroom - новый инициализированный экземпляр, или (False, comment)

get_list([return_type = False, objects=True])

получение списка отделов.

Note

Заполняет атрибуты класса: list_workroom, dict_by_name, dict_by_id (см. Атрибуты )

Параметры:

• return_type - параметр определяющий структуру возвращаемой информации:

  False:возврат (True, [список отделов - экземпляры или словари]) ‘by_name’:возврат - (True, {словарь по именам - значения отделы}) ‘by_id’:возврат- (True, {словарь по id - значения отделы})

• objects (bool) - определяет в каком виде возвращаются отделы, если False - то словари, а если True - то экземпляры класса workroom
• return - (True, data) , или (False, comment)

get_name_by_id(id)

возвращает имя отдела по его id.

Note

возможно лучше не использовать

Параметры:

• id (str)- id отдела
• return - (True, workroom_name) или (False, комментарий).

get_id_by_name(name)

возвращает id отдела по его имени.

Note

возможно лучше не использовать

Параметры:

• name (str)- имя отдела.
• return - (True, workroom_id) или (False, комментарий).

name_list_to_id_list(name_list)

возвращает список id по списку имён

Note

возможно лучше не использовать

Параметры:

• name_list (list)- список имён
• return - (True, list_of_id) или (False, комментарий).

id_list_to_name_list(id_list)

возвращает список имён по списку id

Note

нужен при записи

Параметры:

• id_list (list)- список id
• return - (True, name_list) или (False, комментарий).

rename_workroom(new_name)

переименование отдела (текущего экземпляра). перезапись параметра name.

Параметры:

• new_name (str)- новое имя отдела.
• return - (True, ‘Ok!’) или (False, комментарий).

edit_type(new_type_list)

замена типов отдела (текущего экземпляра). перезапись параметра type. Отделу присваивается один или несколько типов задач - для которых он предназначен.

Параметры:

• new_type_list (list)- список типов из task_types
• return - (True, ‘Ok!’) или (False, комментарий).