Class Workroom(studio)

class edit_db.workroom

level = „studio“

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

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

Examples

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

import edit_db as db

workroom = db.workroom()
name

Имя отдела (уникально).

Type:str
id

uuid.hex

Type:str
type

Список типов задач из edit_db.studio.task_types, которые выполняются данным отделом.

Type:list
add(keys, new=False)

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

Параметры:
  • keys (dict) – Словарь ключей по edit_db.studio.workroom_keys, name - обязательный параметр.
  • new (bool, optional) – Если True - то возвращает инициализированный экземпляр.
Результат:

  • Если new= True - экземпляр класса edit_db.workroom.
  • Если new= False - (True, „Ok!“) или (False, comment).
Тип результата:

edit_db.workroom, tuple
add_artists(artists)

Добавление списка артистов в отдел.

Параметры:artists (list) – Список добавляемых в отдел артистов (объекты :obj:`edit_db.artist).
Результат:(True, „ok!“) или (False, comment)
Тип результата:tuple
dict_by_id = None

атрибут класса словарь отделов даной студии (экземпляры) с ключами по id. Заполняется привыполнеии метода edit_db.workroom.get_list(), значение по умолчанию - {}.

Type:dict
dict_by_name = None

атрибут класса словарь отделов даной студии (экземпляры) с ключами по name. Заполняется привыполнеии метода edit_db.workroom.get_list(), значение по умолчанию - {}.

Type:dict
edit_type(new_type_list)

Замена типов задач с которыми работает данный отдел (текущий экземпляр). Перезапись параметра edit_db.workroom.type.

Параметры:new_type_list (list) – Список типов задач для отдела. Типы задач - значения из edit_db.studio.task_types.
Результат:(True, „Ok!“) или (False, comment).
Тип результата:tuple
get_list(return_type=False, objects=True)

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

Примечание

Заполняет атрибуты класса: edit_db.workroom.list_workroom, edit_db.workroom.dict_by_name, edit_db.workroom.dict_by_id.

Внимание

Учитывая вышесказанное - про заполнение атрибутов класса - история с return_type излишня - достаточно возвращать тру-ок.

Параметры:
  • return_type (str) – параметр определяющий структуру возвращаемой информации значения из [False, 'by_name', 'by_id'].
  • objects (bool) – Определяет в каком виде возвращаются отделы, если False - то словари, а если True - то экземпляры класса edit_db.workroom.
Результат:

  • Если return_type= False - (True, [список отделов (экземпляры или словари)]) или (False, comment).
  • Если return_type= 'by_name' - (True, {словарь по name - значения отделы (экземпляры или словари)}) или (False, comment).
  • Если return_type= 'by_id' - (True, {словарь по id - значения отделы (экземпляры или словари)}) или (False, comment).
Тип результата:

tuple
id_list_to_name_list(id_list, read_db=False)

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

Примечание

Используется при записи.

Параметры:
  • id_list (list) – Список id отделов.
  • read_db (bool) – Если False и данные по отделам уже считывались - то чтение базы данных не будет.
Результат:

(True, list_of_names) или (False, comment).
Тип результата:

tuple
init_by_keys(keys, new=True)

Инициализация по словарю (без чтения БД), возвращает новый, или инициализирует текущий экземпляр.

Параметры:
  • keys (dict) – Словарь по edit_db.studio.workroom_keys
  • new (bool, optional) – Если True - возвращает новый инициализированный экземпляр, если False то инициализирует текущий.
Результат:

  • если new= True - экземпляр класса edit_db.workroom,
  • если new= False - (True, „Ok!“) или (False, comment)
Тип результата:

edit_db.workroom, tuple
list_workroom = None

атрибут класса список отделов даной студии (экземпляры). Заполняется привыполнеии метода edit_db.workroom.get_list(), значение по умолчанию - [].

Type:list
name_list_to_id_list(name_list, read_db=False)

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

Параметры:
  • name_list (list) – Список имён отделов.
  • read_db (bool) – Если False и данные по отделам уже считывались - то чтение базы данных не будет.
Результат:

(True, list_of_id) или (False, comment).
Тип результата:

tuple
remove_artists(artists)

Удаление списка артистов из отдела

Параметры:artists (list) – Список удаляемых из отдела артистов (объекты :obj:`edit_db.artist).
Результат:(True, „ok!“) или (False, comment)
Тип результата:tuple
rename_workroom(new_name)

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

Параметры:new_name (str) – Новое имя отдела.
Результат:(True, „Ok!“) или (False, comment).
Тип результата:tuple