Сохранение скриншотов

resources/archive/shot_saver.py

Модуль предоставляет высокоуровневый интерфейс для асинхронного сохранения скриншотов в виде класса ShotSaver.

Аргументы класса

• pool_size (int, optional): Максимальное кол-во одновременно сохраняемых скриншотов. По умолчанию 10.
• callback (callable[str, str], optional): Callback функция, которая вызывается после сохранения скриншотов. В функцию передается guid задачи на сохранение и текущий статус задачи.

Публичные атрибуты класса

• timeout_sec (int): Время ожидания скриншота, сек. По умолчанию 10.
• buffer_ts(int): Время ожидания для создания скриншота с фигурами. По умолчанию 0.
• max_tries (int): Кол-во попыток сохранить скриншот. По умолчанию 2.
• callback (callable[str, str]): Тоже что аргумент callback
• pool_size (int): Тоже что аргумент pool_size
• screenshots_folder (str): Папка сохранения скриншотов по умолчанию если не задана в другая при вызове метода. По умолчанию папка скриншота сервера.

Методы класса

• save - Сохранение скриншота в файл. Возвращает guid задачи и путь, куда скриншот будет сохранен.
  Аргументы метода:
  
  • channel_full_guid (str): Guid канала вида ChannelGuid_ServerGuid
  • dt (datetime.datetime, optional): Дата/время сохранения скриншота. По умолчанию текущая дата/время.
  • figures (bool, optional): Если True - сохраняет скриншот с фигурами. По умолчанию False.
  • file_name (str, optional): Название файла скриншота. По умолчанию формируется по шаблону {channel.name} (%Y.%m.%d %H-%M-%S.%f).jpg В имени скриншота поддерживается форматирование даты/времени (доступные аргументы доступны на сайте https://strftime.org/) а также объект channel и server.
  • file_path (str, optional): Полный путь для сохранения скриншота. По умолчанию сохраняет в папку, которая задана в атрибуте screenshots_folder
  • callback (callable[str, str], optional): Callback функция, которая вызывается после сохранения скриншотов. В функцию передается guid задачи на сохранение и текущий статус задачи. Если не задана - используется callback класса.
  • task_guid (str, optional): Guid задачи. По умолчанию задается с помощью функции host.random_guid()
• get - Возвращает в callback изображение, bytes 
  Аргументы метода:
  • channel_full_guid (str): Guid канала вида ChannelGuid_ServerGuid
  • dt (datetime.datetime, optional): Дата/время сохранения скриншота. По умолчанию текущая дата/время.
  • figures (bool, optional): Если True - сохраняет скриншот с фигурами. По умолчанию False.
  • callback (callable[str, str]): Callback функция, которая вызывается после сохранения скриншотов. В функцию передается guid задачи на сохранение и текущий статус задачи. Если не задана - используется callback класса. Если еще и callback класса не задана, вызовет ошибку EnvironmentError

Возможные статусы сохранения скриншота содержатся в объекте status:

• status.saving - Скриншот сохраняется.
• status.error - Ошибка сохранения скриншота.
• status.success - Скриншот успешно сохранен.
• status.in_queue - Скриншот добавлен в очередь на сохранение.

Примеры кода

Простой пример

Просто сохраняем текущий скриншот с канала со стандартным именем в папку скриншотов.

from shot_saver import ShotSaver

CHANNEL_GUID = "uR76TlcA_O4Yazs8u"  # Необходимо заменть на guid Вашего канала

ss = ShotSaver()

ss.save(CHANNEL_GUID)

Изменение папки сохранения скриншотов

Если Вы хотите, чтобы все скриншоты данного скрипта сохранялись в отдельную папку, можно изменить ее глобально для всего класса.

from shot_saver import ShotSaver

CHANNEL_GUID = "uR76TlcA_O4Yazs8u"  # Необходимо заменть на guid Вашего канала

ss = ShotSaver()
ss.screenshots_folder = r"D:\DSSL\shots"

ss.save(CHANNEL_GUID)

Или задать непосредственно при сохранении скриншота

from shot_saver import ShotSaver

CHANNEL_GUID = "uR76TlcA_O4Yazs8u"  # Необходимо заменть на guid Вашего канала

ss = ShotSaver()

ss.save(CHANNEL_GUID, file_path=r"D:\DSSL\shots")

Запрос скриншота за определенную дату/время

Также мы можем менять и имя скриншота, и/или добавлять дату/время за которое хотим сохранить скриншот.
Для примера сохраним скриншот за текущую дату, а время изменим на 00:00:00

import datetime
from shot_saver import ShotSaver

CHANNEL_GUID = "uR76TlcA_O4Yazs8u"  # Необходимо заменть на guid Вашего канала

ss = ShotSaver()

dt = datetime.datetime.combine(
    datetime.datetime.now().date(),  # Текущая дата
    datetime.time()  # Время 00:00:00
)
ss.save(CHANNEL_GUID, dt=dt, file_name="midnight_shot.jpg")

Отслеживание статуса сохранения скриншота

При успешном сохранении открытие полученного изображения.
Мы используем переменную tasks для хранения текущих задач и путей сохранения скриншота для каждой задачи.

import os
import host
from shot_saver import ShotSaver, status

CHANNEL_GUID = "uR76TlcA_O4Yazs8u"

ss = ShotSaver()

tasks = {}


def callback(guid, state):
    host.message("[%s] %s" % (guid, state))  # Отбражаем текущий статус задачи
    if state == status.success:
        # Открываем изображение если скриншот успешно сохранился
        fpath = tasks.pop(guid)
        os.startfile(fpath)
    elif state == status.error:
        # Просто удаляем задачу из списка, если произошла ошибка
        fpath = tasks.pop(guid)
        host.message("Can't save shot: %s" % fpath)


task_guid, file_path = ss.save(CHANNEL_GUID, callback=callback)
tasks[task_guid] = file_path

Получение изображения в bytes

Например для отображения в окне host.question

import base64
import host
from shot_saver import ShotSaver

CHANNEL_GUID = "uR76TlcA_O4Yazs8u"

ss = ShotSaver()

__image_html = """<img src="data:image/png;base64,{img}" width="800">"""


def show_image(image_bytes):
    host.question(
        __image_html.format(img=base64.b64encode(image_bytes)),
        "OK", lambda: 0
    )


ss.get(CHANNEL_GUID, callback=show_image)