Закрыть модуль
Для закрытия указанного модуля используется метод close_module:
close_module(module_id: str) -> Dict:
В методе используется аргумент module_id:
Аргумент | Описание |
---|---|
module_id: str | Идентификатор модуля. |
Пример использования метода:
session.close_module(module_id="4223b8c3-97fd37ac-3052c1e5-0ae92913")
В результате использования метода возвращается ответ от сервера, соответствующий ответу на запрос user_iface: close_module.
Пример ответа:
{'state': 1, 'queries': [{'uuid': '3575415c-2abe8406-fa599328-0f540ba7', 'command': {'plm_type_code': 207, 'state': 16}}]}
Закрыть несколько модулей
Для закрытия нескольких конкретных модулей используется метод close_modules:
close_modules(self, module_ids: Union[list, set, tuple], is_skip: bool = True) -> bool:
В методе используются следующие аргументы:
Аргумент | Описание |
---|---|
module_ids: Union [list, set, tuple] | Идентификаторы закрываемых модулей. |
is_skip: bool | Пропуск модулей, закрыть которые не удалось. Если True, то в случае неудачной попытки закрытия какого-либо модуля ошибки не будет, а все последующие модули будут закрыты; является значением по умолчанию. Если False, то будет сгенерирована ошибка, и все последующие модули не будут закрыты. |
Пример использования метода:
session.close_modules(module_ids={"a2b37477-3627e248-99e4b342-4558b31c", "a2b37477-0e53aadd-3f8eb70a-edb3f7b6"}) или session.close_modules(module_ids=["a2b37477-4dd94f02-bb5ed8dc-ed71c5c1", "a2b37477-9b5d1e44-9feea9cb-a779bf38"], is_skip=False)
В результате использования метода в ответе возвращается True, если все указанные модули были закрыты, и False, если нет.