Class Group(studio)¶

class edit_db.group(project_ob)¶

level = „project“

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

group_keys = {
'name': 'text',
'type': 'text',
'season': 'text',
'description': 'text',
'id': 'text',
}

Examples

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

import edit_db as db

project = db.project()
group = db.group(project) # project - обязательный параметр при создании экземпляра group
# доступ ко всем параметрам и методам принимаемого экземпляра project через group.project

name¶

Имя группы (уникально).

Type:	str

type¶

Тип ассетов данной группы, из edit_db.studio.asset_types.

Type:	str

season¶

id сезона ?

Type:	str

description¶

Краткое писание.

Type:	str

id¶

uuid.hex.

Type:	str

project¶

Проект принимаемый при создании экземпляра класса, содержит все атрибуты и методы edit_db.project.

Type:	`edit_db.project`

create(keys, new=True)¶

Создание группы.

Параметры:

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

Результат:

если new= True - новая группа, экземпляр класса edit_db.group,
если new= False - (True, „Ok!“) или (False, comment).

Тип результата:

edit_db.group, tuple

create_recycle_bin()¶

Создание группы - корзина, для удалённых ассетов. Процедура выполняется при создании проекта.

Результат:	(True, „Ok!“) или (False, comment).
Тип результата:	tuple

dict_by_id = None¶

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

Type:	dict

dict_by_name = None¶

атрибут класса словарь групп (экземпляры edit_db.project) с ключами по именам. Заполняется привыполнеии метода edit_db.group.get_list(), значение по умолчанию - None.

Type:	dict

dict_by_type = None¶

ключи - type, значения - списки групп (экземпляры edit_db.project). Заполняется привыполнеии метода edit_db.group.get_list(), значение по умолчанию - None.

Type:	dict
Type:	`атрибут класса` словарь групп

edit_description(description)¶

Редактирование описания текущего объекта группы.

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

get_by_id(id_)¶

Возвращает группу(экземпляр) по id. Обёртка на edit_db.group.get_by_keys().

Параметры:	id (str) – `id` группы.
Результат:	(True, `edit_db.group`) или (False, comment)
Тип результата:	tuple

get_by_keys(keys)¶

Возвращает список групп(экземпляры) удовлетворяющих keys.

Параметры:	keys (dict) – Словарь по `edit_db.studio.group_keys`.
Результат:	(True, [список групп (экземпляры `edit_db.group`)]) или (False, comment)
Тип результата:	tuple

get_by_name(name)¶

Возвращает группу(экземпляр) по имени. Обёртка на edit_db.group.get_by_keys().

Внимание

Нужно ли это, или это функция init.

Параметры:	name (str) – Имя группы.
Результат:	(True, `edit_db.group`) или (False, comment)
Тип результата:	tuple

get_by_type_list(type_list)¶

Возвращает список групп (экземпляры) по списку типов. Обёртка на edit_db.group.get_list().

Параметры:	type_list (list) – Список типов ассетов из `edit_db.studio.asset_types`.
Результат:	(True, [список групп - экземпляры `edit_db.group`]) или (False, comment)
Тип результата:	tuple

get_list(f=False)¶

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

Примечание

Заполняет атрибуты класса:

edit_db.group.list_group,
edit_db.group.dict_by_name,
edit_db.group.dict_by_id,
edit_db.group.dict_by_type.

Параметры:	f (list, optional) – Список типов(типы ассета `edit_db.studio.asset_types`), если False - то всех типов.
Результат:	(True, [список групп (экземпляры `edit_db.group`)]) или (False, comment)
Тип результата:	tuple

init(group_name, new=True)¶

Инициализация по имени, возвращает новый, или инициализирует текущий экземпляр.

Параметры:

group_name (str) – Имя группы
new (bool) – Если True - возвращает новый инициализированный экземпляр, если False то инициализирует текущий экземпляр.

Результат:

если new= True - экземпляр класса edit_db.group,
если new= False - (True, „Ok!“) или (False, comment)

Тип результата:

edit_db.group, tuple

init_by_keys(keys, new=True)¶

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

Параметры:

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

Результат:

если new= True - экземпляр класса edit_db.group,
если new= False - (True, „Ok!“) или (False, comment)

Тип результата:

edit_db.group, tuple

list_group = None¶

атрибут класса список групп (экземпляры edit_db.project) даного проекта. Заполняется привыполнеии метода edit_db.group.get_list(), значение по умолчанию - None.

Type:	list

rename(new_name)¶

Переименование текущего объекта группы.

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