Python Заметки

🤩 Разбираем полезные исходники!

Функция, возвращающая словарь с данными о панели задач.

screen : номер монитора
location : расположение на экране (внизу, слева и тд)
geometry : QRect с координатами таскбара
system_tray : доступен ли системный трей

🔸 Как может пригодиться?
Я использую для открытия виджета по клику на значке в трее с выравниванием по таскбару. Аналогично работает попап у Dropbox клиента.

🔸 Тестил на Windows10 и Debian10.

🔸 В комплекте проверочный виджет который при создании точно перекрывает таскбар. Проверка правильности определения геометрии таскбара. Закрывается по клику.

🔸 Ещё в комплекте пример окошка, которое появляется в районе часов над таскбаром.

🔸 Есть один баг. При перекрытии тасбара в Gnome (linux) виджет не получает событий от мыши.
Решения пока не нашел😕

Код забираем здесь ↗️

#source #qt

import sys
print(sys.implementation)

Выполнив этот код, вы увидите некий объект namespace с данными о текущей имплементации интерпретатора.

Помимо того что эта информация может быть как-либо полезна давайте обратим внимание на то, что это за объект вообще?
Узнаем что это за тип

>>> type(sys.implementation)
<class 'types.SimpleNamespace'>

SimpleNamespace это простой тип для реализации неймспейса.

Если не знаете что такое неймспейс, то представьте себе некий объект-контейнер, куда можно складывать другие объекты. После чего обращаться к ним через имя контейнера. То есть, к имени объекта добавляется дополнительный уровень имени, что и является пространством имён.
По сути, любой модуль и класс является неймспейсом для своего содержимого (если не импортить это содержимое из модуля через "*").

Класс SimpleNamespace позволяет легко добавлять и удалять атрибуты. А также можно передать в конструктор keyword аргументы чтобы сразу создать нужные атрибуты

>>> from types import SimpleNamespace
>>> conf = SimpleNamespace(key1=1, key2=2)
>>> conf.key1
1
>>> setattr(conf, 'key3', 3)
или
>>> conf.key3 = 3
>>> conf.key3
3
>>> delattr(conf, 'key2')
или
>>> del conf.key2
>>> conf
namespace(key1=1, key3=3)

Вот так можно преобразовать словарь в неймспейс:

>>> keys_dict = {'k1': 1, 'k2': 2}
>>> keys = SimpleNamespace(**keys_dict)
>>> keys
namespace(k1=1, k2=2)

Обратное преобразование через vars

>>> vars(conf)
{'key1': 1, 'key3': 3}

Как это можно использовать?

▫️ красиво оформить "константы" или конфиг. В этом случае, кстати, я бы делал ключи аперкейсом.

>>> conf = SimpleNamespace(
**json.load(config_file.open())
)
>>> conf.API_HOST
"192.168.10.20"

▫️ быстро преобразовать словарь в подобие объекта с доступом к ключам через атрибуты. То есть вместо такой записи:

shape['width']

можно будет писать так:

shape.width

▫️альтернатива для namedtuple, в которой доступно изменение значения атрибутов.

#tricks

https://devdocs.io/python~3.9/

Интерактивный поиск по документации Python. Просто наберите имя функции, класса или модуля и сразу получите статью.
Поиск умный, может найти неточное совпадение. Например когда допустили опчепятку в слове. Попробуйте поискать по слову "mltprcsng"

#basic

Порой админу проще написать огромный bash-скрипт с запросами в БД и парсингом через регулярки чем пытаться тоже самое изобразить в Python. Тоже самое верно и в обратном случае. Даже простые shell команды порой удобней записать в Python скрипт чем на bash. Правда, в обоих случаях выглядит это всё не очень.
Если сталкивались с таким, то поймёте о чем я😢
Специально для вас сделал подборку библиотеки для работы с shell из Python. Чтобы ваш код оставался красивым и читабельным!

➡️ sh
Переносим bash синтаксис в Python. Удобно и немногословно.
Ранее я уже рассказывал про этот модуль, можно глянуть в этом посте.

➡️ plumbum
Аналогичен sh но со своими плюшками. Например встроенная колоризация вывода

➡️ pexpect
Библиотека для интерактивного взаимодействия с процессом через stdin/stdout.
Нашел небольшой гайд на русском.

➡️ shell_command
Еще одна библиотека для вызова shell-команд. Ориентируется на безопасность вызываемого кода и заточена на удобство для админов.

Бонусом
➡️ envoy
Обёртка вокруг subprocess делающая его использование еще проще и минималистичней.
_______________
Кстати, до Python 2.6 вместо subprocess была библиотека commands. Выглядит достаточно аскетично)

#libs

Иногда хочется чтобы в качестве объекта передачи данных был удобный класс но не хочется (или нет возможности) писать сераиализатор в JSON для него. Идеально было бы сделать класс, который сам умел бы сериализоваться в JSON дефолтным модулем без указания дополнительных сериализаторов.
Как это сделать?

Стандартный модуль JSON умеет правильно сериализовать стандартные типы. Но нам нужен кастомный класс с удобными методами и свойствами. Ответ очевиден - наследуемся от стандартного типа!

В качестве базового типа возьмем словарь. Например, мне нужен класс некоего абстрактного элемента списка с именем и индексом. Тогда реализация может быть такой.

class Item(dict):
  def __init__(self, name, index=0):
    super().__init__(name=name, index=index)

  @property
  def name(self):
    return self['name']

  @name.setter
  def name(self, value):
    self['name'] = value

  @property
  def index(self):
    return self['index']

  @index.setter
  def index(self, value):
    self['index'] = value

  def __setitem__(self, key, value):
    if key not in ['index', 'name']:
      raise KeyError
    super().__setitem__(key, value)

Я добавил два свойства с простым переназначением данных в словарь. Но предполагается, что там будут проверки значений и иные вычисления. Еще хорошо бы добавить методы __str__ и __repr__.

>>> it = Item('item name')
>>> it.name
'item name'
>>> it.index
0

Также можно добавить любые методы классу. Например я переопределил __setitem__ чтобы нельзя было задать иные ключи.

>>> it['key'] = 123
KeyError

Хотя, можно сделать как-то иначе. К примеру, все отличные от основных ключи записывать в отдельный ключ.

  def __setitem__(self, key, value):
    if key not in ['index', 'name']:
      self['meta'][key] = value
    else:
      super(Item, self).setitem(key, value)

Ну а главная особенность этого класса в том, что он легко понимается стандартным модулем json (конечно, если значения ключей это тоже стандартные типы или наследованные от них)

>>> json.dumps(item)
'{"index": 2, "name": "item name"}'

Самый очевидный пример, использование в библиотеке requests. Передавая объект в аргумент json, мы не можем повлиять на его сериализацию, то есть добавить класс-сериализатор. Там ожидается готовый словарь или иной совместимый тип.

import requests
requests.post(url, json=item)

А вот так выглядит альтернатива с методом toJson()

requests.post(url, data=item.toJson(), 
  headers={'Content-Type': 'application/json'})

А ещё ничто не мешает нам в любой момент конвертнуть наш класс в обычный словарь

>>> dict(item)
{"index": 2, "name": "item name"}

Не спорю, возможно есть более "умные" решения этой задачи 🤓 Но, тем не менее, аналогичным образом работает стандартный collections.namedtuple. Он тоже наследуется от стандартного tuple, расширяет его функционал и сериализуется без дополнительных средств.

Для более сложных случаев можно посмотреть на библиотеку dataclasses-json, которая поможет сериализовать dataclasses.

#tricks #libs

Стандартная Django админка работает стабильно но не могу сказать что она меня устраивает. Да, есть базовый набор стандартного функционала, но чего-то всегда не хватает. Может автокомплитов а может тёмной темы. 😎

Долгое время я использовал DjangoSuit, но проект заглох на невыпущенной альфе 2й версии которая в Django3 и вовсе не поддерживается.

Что же можно сегодня посоветовать?
На сегодняшний день у меня два фаворита:

🚀 DjangoJET
🌎 сайт
🗄 репозиторий
▶️ видео

Крутая и красивая админка с кучей плюшек.
▫️автокомплиты с AJAX подгрузкой
▫️темы
▫️дашборды
▫️респонсив
▫️кастомизация панелей прямо в админке

Стоит денег для коммерческих продуктов. Для опенсорса бесплатно (AGPL)!

🎷 Django Jazzmin
🗄репозиторий

Не такая пафосная но от этого не менее крутая админка.
▫️полностью кастомизируется
▫️много готовых тем и возможность собрать свою прямо в админке
▫️Bootsrtap Model окна вместо всплывающих окон
▫️интегрирован Select2
▫️респонсив

Знаете еще крутые админки? Напишите в комментах!

#django #libs

Кроме стандартных системных ивентов аудита можно вызывать свои ивенты. Для этого используется функция sys.audit()

import sys

def my_hook(event, args):
    if event == 'mymodule.myevent':
        print('Catched!', args)

sys.addaudithook(my_hook)

sys.audit('mymodule.myevent', 1, 2, 3)

Просто указываем имя ивента первым аргументом и далее любые аргументы.

Такое будет полезно если вы разрабатываете серьезную библиотеку в которой вопрос безопасности стоит не на последнем месте. Дать возможность другим разработчикам добавлять свои проверки будет хорошей практикой!
Хотя никто не запрещает придумать свой способ использования перехвата подобных событий.

Особенно это будет знакомо тем, кто пишет приложения на PyQt. Очень уж похоже на систему сигнал/слот в режиме DirectConnection.

▫️ следует вызывать sys.audit() ПОСЛЕ проверки данных но ДО фактического применения и исполнения логики. Это поможет избежать лишней проверки данных вне основной логики и прервать операцию в нужный момент.
▫️ в имени ивента рекомендуется использовать неймспейс с именем вашего модуля.

#tricks

Для Python3.8 в PEP0578 добавили функционал аудита Runtime операций. Это позволяет выполнять хуки (функции) при возникновении определённых событий в интерпретаторе.

Этот функционал разработан, прежде всего, для специалистов по безопасности. Аудит позволяет перехватывать различные действия и проверять их допустимость.

Полный список стандартных аудит-ивентов можно посмотреть здесь. Из названий становится ясно что мы можем перехватить. Например, мы можем перехватить факт открытия файла (open), импорта модуля (import), копирование файла (shutil.copyfile), запуск процесса (subprocess.Popen) и тд. Как минимум мы можем залогировать данное событие, как максимум, вызвать аварийное завершение программы.

Примеры использования:

▫️Представим, что после разработки и долгих тестирований веб сервиса вы могли где-то оставить функцию ручного ввода данных в консоль. На продакшене такое недопустимо. С помощью аудита можно вызвать исключение перехватив ивент builtins.input

▫️С помощью ивента socket.getaddrinfo можно определить на какие сайты юзер заходил с помощью вашего приложения.

▫️Ивент exec позволит проверить загруженный объект кода перед его исполнением. Например выявить потенциально опасный код, или оставленные API ключи в строковых переменных.

Как добавить свой хук?

Для первого теста выполните такой код в самом начале работы приложения

import sys

def hook(event, args):
    print(f'EVENT: {event}{args}')

sys.addaudithook(hook)

Каждый хук вызывается для всех событий, поэтому мы можем с помощью одного хука увидеть всё что происходит в интерпретаторе.
Теперь давайте посмотрим какие web-коннекты создаются при работе нашего кода. Для запросов используем requests.

import sys
import requests

def socket_hook(event, args):
    if event == 'socket.getaddrinfo':
        print(args[0])

sys.addaudithook(socket_hook)
requests.get('https://google.com')

В аутпуте вы увидите домен, на который был сделан запрос.

А так же:
▫️есть платформозависимые хуки (например взаимодействие с winapi)
▫️можно писать хуки на Си
▫️так как это мера для обеспечения безопасности, нет способа удалить хуки после добавления.

Напоминаю, доступно в Python3.8+

#pep #tricks

8 Марта🌸 вышел альфа-релиз Python 3.10.0a6
Уже сейчас можно его скачать и попробовать новый синтаксис Switch Statement, о котором я упоминал ранее.
В Python его назвали Structural pattern matching

Итак, как это теперь выглядит?

match QUERY:
    case VALUE1:
        return 1
    case VALUE2:
        return 2
    case VALUE3:
        return 3
    case _: # default
        return 0    

Для объединения нескольких значений в одном кейсе используем вертикальную черту

match QUERY:
    case VALUE1 | VALUE2:
        return 3
    case _: # default
        return 0

Также можно добавлять дополнительные проверки с if

match QUERY:
    case VALUE1:
        return 1
    case VALUE2 | VALUE3 if x < 5:
        return 2
    case _: # default
        return 0

Выглядит как синтаксический сахар для конструкции if..elif..else. В целом не плохо, но и непривычно)

#tricks

😊🌸🥂🌹😘

#offtop

В Python есть удобный почтовый debug-сервер. Он поможет проверить работу почты вашего web-проекта на этапе разработки без необходимости настраивать внешние сервисы или взаимодействие с реальными серверами Google или Yandex. Этот сервер просто печатает все сообщения в консоль.
Таким образом удобно дебажить одноразовые ссылки активации или просто факт отправки письма по расписанию.

Запускается очень просто:

python3 -m smtpd -n -c DebuggingServer localhost:1025

Теперь настройте ваш проект на использование этого сервера. Например вот так настраивается Django:

# settings.py
if DEBUG:
    EMAIL_HOST = 'localhost'
    EMAIL_PORT = 1025
    EMAIL_HOST_USER = ''
    EMAIL_HOST_PASSWORD = ''
    EMAIL_USE_TLS = False
    DEFAULT_FROM_EMAIL = 'noreply@mysite.com'

#django #tricks

Несмотря на то, что проекты линейки Qt For Python (все версии PySide и PyQt) считаются полноценными production-решениями, они всё еще недоделаны и постоянно развиваются. В частности, не все классы оригинального С++ фреймворка реализованы с Python-версиях.
Некоторые классы действительно пропущены за ненадобностью. Например, вместо QVariant можно использовать любой Python-объект, вместо QString простые Python-строки и тд.
Но есть классы до которых просто еще не добрались разработчики.

На этой странице↗️ можно посмотреть полный список нереализованных классов. При этом в разных биндингах состав может отличаться. К примеру те же QString и QVariant всё ещё доступны в PyQt4.

#qt

Как получить класс из модуля зная только его dotted-path?
Что за dotted-path? Это путь импорта через точки вроде такого:

"package.module.clsName"

Так как мы не можем закинуть строку в директиву import то повторим то, что она делает только "вручную"

mod = __import__('package.module', fromlist=['clsName'])
cls = getattr(mod, 'clsName')

Похожий способ с importlib

import importlib
module = importlib.import_module('package.module')
cls = getattr(module, 'clsName')

В обоих случаях приходится дополнительно обрабатывать строку чтобы отрезать имя класса от имени модуля. Так как мы сначала импортим модуль а потом достаём из него нужный объект.

Есть ли способ просто закинуть всю строку и получить результат?

Если пишете проект на Django то в нём есть функция import_string(). Она используется для импорта объектов, указанных в settings.py в виде dotted-path.

from django.utils.module_loading import import_string
cls = import_string('package.module.clsName')

Если же у вас "чистый" Python то на помощь придёт модуль pydoc. У него тоже есть аналогичный метод для импорта объектов по dotted-path.

from pydoc import locate
cls = locate('package.module.clsName')

В Python3.9 добавили еще один способ ресолвинга имени в объект. Теперь это самый актуальный способ на данный момент!

import pkgutil
cls = pkgutil.resolve_name('package.module.clsName')

____________
Конечно же это не относится только к классам. Точно так же можно импортнуть любой объект, вложенный в модуль.

#tricks

20 Февраля 1991 года вышла первая beta-версия Python v0.9.0.
С тех пор минуло 30 лет! 😮
Сегодня мы имеем один из самых популярных языков программирования в мире.

Поздравляем Python c юбилеем! ⭐️🎉🎁🐍👍

Узнать, как это было можно, поставив себе первый релиз с помощью conda

#offtop

Еще один пример с ресурсами.
Читаем картинку из PYZ архива сразу в QImage и далее используем как иконку в GUI.
Без сохранения в промежуточный файл!

Запускать так:

python3 pkg_img.pyz

▫️Из зависимостей только PySide2.
▫️Помним, что это просто ZIP. То есть исходники можно легко достать из архива.

#source

Ранее я показал как упаковать ваше Python-приложение в ZIPAPP.
В дополнение к этой теме покажу ещё один способ как достать изображение из архива, не сохраняя его на диск и сразу перегнать в класс PIL.Image для дальнейших манипуляций.

Что есть ресурс в данном контексте? Это любой объект который можно прочитать как файл.

В Python 3.7 появился новый стандартный способ работы с ресурсами внутри пакетов. Это модуль importlib.resources.
Его следует использовать и для случаев с контейнерами (ZIP, EGG) и для обычных пакетов.

Для начала импортнём нужные модули

from importlib.resources import read_binary
from PIL import Image
import io

Читаем файл ресурса из пакета

data = read_binary("package_name", "image.jpg")

Создаём класс Image

img = Image.open(io.BytesIO(data))

Картинка загружена в память, можно с ней что-то делать

img.thumbnail((200, 200))

И после изменений сохранить в файл

img.save(path, 'JPG')

или использовать еще как-то

img.show()

Модуль получил бекпорт для старых версий в виде стороннего пакета importlib_resources.

До появления этого модуля использовался модуль pkg_resources, входящий в состав setuptools. Но он теперь неактуален.

#libs

Как получить список всех модулей, доступных для импорта?

pip list

Эта команда выдаст список инсталлированных модулей, но не всех что доступны.

help('modules')

или

python -m pydoc modules

Покажет все модули которые можете импортнуть, включая те, что доступны благодаря переменной PYTHONPATH.
Уже лучше, но проблема лишь в том, что функция печатает всё в аутпут, а нам нужен список строк.

Конечно же в Python есть способ сделать всё просто и логично😉

import pkgutil
modules = [m.name for m in pkgutil.iter_modules()]

Вернёт имена всех модулей, доступных для импорта, кроме builtin модулей.
Просто добавим их отдельно:

import sys
modules.extend(sys.builtin_module_names)

Теперь мы получили полный список всех доступных для импорта модулей и пакетов, включая те, что подгружены через PYTHONPATH или динамически добавлены через sys.path.

#tricks

Как правильно проверить атрибуты доступа файла? То есть доступна ли запись в файл или является ли он исполняемым?
Для этого в Python есть функция os.access()
Проверять так:

os.access(path, flag)

Функция вернёт bool в зависимости от наличия указанного флага.

Всего есть 4 флага проверки:

os.F_OK - наличие файла на диске
os.R_OK - доступ на чтение
os.W_OK - доступ на запись
os.X_OK - доступ на исполнение

Например, вместо try-except лучше делать так (пример из документации):

if os.access("myfile", os.R_OK):
    with open("myfile") as fp:
        return fp.read()

#basic #libs

GUI для Pyinstaller

Auto PY to EXE — GUI-обёртка для Pyinstaller!
Создаём команду сборки с помощью диалога. Для профессионалов пользы не много, а начинающим будет интересно посмотреть какие есть основные опции у Pyinstaller и как они выглядят в команде.

🎬 Видео урок
📦 Репозиторий
❓FAQ по использованию

PS. Пусть вас не смущает слово EXE в названии и Windows в уроке. Эта штука работает и на Linux и на MacOS.

#libs

Как быстро отрезать от пути несколько элементов с любой стороны?
Например, есть длинный путь:

path = '/home/user/projects/proj1/assets/assetname/geo/publish/v001/body.geo'

Для удобного отображения логов (или еще какой-то абстрактной задачи) я хочу видеть только 3 последних элемента.

▫️Сейчас мы не будем усложнять задачу с выделением только нужных элементов с парсингом самой строки. Работаем только с индексами элементов.
▫️Учитываем, что путь может прийти с неизвестно куда направленными слешами.
▫️Хочу реализацию в одну строку

Вот так можно это сделать с помощью модуля os.path

>>> os.path.join(
... *os.path.normpath(
... path
... ).replace(
... '\\', '/'
... ).split('/')[-3:])
'publish/v001/body.geo'

Монструозно, но работает👹

Более красивый вариант это класс pathlib.Path.
У него есть две функции, которые нам помогут

🔸 Свойство parts, которое возвращает список элементов пути.
🔸 Конструктор Path() может принимать несколько строк которые объединятся в один путь. То есть аналогично функции join.

>>> Path('folder', 'file')
PosixPath('folder/file')

Поэтому мы можем сделать так:

>>> Path(*Path(path).parts[-5:])
PosixPath('publish/v001/body.geo')

Ну вот, более лаконично (питонично🙄)
А еще можно вырезать середину, оставив начало и конец

>>> p = Path(path)
>>> Path(*p.parts[:3],'...', *p.parts[-2:])
PosixPath('/home/user/.../v001/body.geo')

#tricks #libs