Skip to content

ReturnWrapper

Класс ReturnWrapper возвращают многие методы, особенно те, что используются в АПИ. В нем всего четыре поля.

Поля класса Return Wrapper
level: Result
Это энам. Всего у него три значения, ERROR, DEBUG, SUCCESS. Методы, которые используются в API, обычно не возвращают DEBUG. Это нужно только для тех случаев, когда действие не завершено успешно, но это, типа, нормально и нужно оставить в логе соответствующее сообщение. Если result у метода ERROR, то вызывается SpiceException.
message: str
Сообщение с объяснением, что ваще случилось, обычно играет важную роль, если это ошибка. Если все успешно, обычно не играет особой роли, важная инфа передается в extra_data.
logged_object: Any
Тут передается класс объекта. Имеет смысл, если это энтити, кризис, меха или плеер. Почему так сложно - долго объяснять, просто смиритесь с этим.
extra_data: dict
Тут в словаре передается дополнительные данные. Обычно это что-то, что нужно вернуть в случае успешного действия.

У этого класса один метод, to_dict, который возвращает словарь с ключами "type" и "message", а так же объединяет эти поля с данными из extra_data, так что возвращается вам не вложенный словарь, а одноуровневый, если, конечно, вы не засунули словари внутрь словаря extra_data.