wxPython + py2exe: помилкии по-людськи

Передмова

Які б додатки не створювались, на різних етапах розробки і підтримки додатків статься непередюачувані помилки, які потрібно якось відловлювати. В цьому пості иова піде про облагороджування десктопних додатків під windows, створених на wxPython і загорнутих в виконуваний файл за допомогою py2exe.

Необхідні знання

Перше - конструктор wx.App

Отже, почнемо. Перше, що потрібно знати, це параметри конструктора класу додатку wx.App. В даному випадку нам цікаві аргументи redirect та filename.

- redirect - відповідає за переспрямування потоків стандартного виводу і потоку помилок. Якщо значення True (а на Windows по замовчуванню так і є), стандартний вивід буде переспрямований.

- filename - власне пункт призначення переспрямованого потоку (див. redirect). Якщо значення не встановлено, то бто рівне None (а на Windows по замовчуванню так і є), стандартне виведення буде переспрямоване в стандартне вікно (воно, як відомо, складається з текстової області, в яку сипляться помилки і решту виведення). Вікно можна перевизначити, встановивши атрибут outputWindowClass екземпляру класу додатку (wx.App).

Друге - переспрямування потоків виводу

Керування стандартними потоками виводу можна здійснювати через вбудований модуль sys. Доступ до них можна отримати через sys.stdout, sys.stderr. Ці змінні - це file-подібні об'єкти, в яких можна щось писати.

Третє - попередження

Попередження (warnings) стаються досить часто, ві DeprecationWarning до маси будь-яких інших, таких як можливі порушення безопеки та ін.. Це нормальна поведінка і придумувати нічего не треба, їх можна просто відключити.

Збираємо все разом

Те, що вже було сказано

Для мене набільш зручною схемою роботи з помилками виявилось не переспрямування в файл, а розподіл потоків виводу і помилок в два різні файлы. Таким чином в файл з помилками будуть сипатись помилки, а в файл виводу - логи (таким чином зручно зберігати і вести деякі application-specific журнали і, наприклад, час від часу відправляти статистику розробнику з ціллю підвищення якості роботи додатку). Таким чином, у випадку виникнення помилки користучас побачить тільки вікно з повідомленням про помилку і пропозицією глянути в такий-то файл з описом помилки, тобто з логом. Також відключимо вивід попереджень. Виглядає це приблизно так:

import sys

import warnings

...

warnings.simplefilter('ignore')

...

sys.stdout = open(logs_dir.decode('cp1251') + '\\my_stdout.log'.decode('cp1251'), 'w')

sys.stderr = open(logs_dir.decode('cp1251') + '\\my_stderr.log'.decode('cp1251'), 'w')

...

app = MyApp(redirect=0)

...

Зміст декодування з cp1251 в тому, що шлях до папки з логами (logs_dir) ми отримали звідкись, а так як ОС у нас Windows, кириличні назви папок ніхто не відміняв.

Невеличкі проблеми з правами

Так історично склалось, що в Windows додатки прийнято встанолювати в папку "Program Files" на логічному диску з системою (в 64-бітних версіях Windows є дві таких папки: "Program Files" і "Program Files x86", думаю, призначення зрозуміле). Проблема в тому, що деякі користувачі системи можуть не володіти правами адміністратора, тому логи вести в папці з додатком ніяк не вийде, тому що обмежений в правах користувач не зможе писати в файл, що знаходиться в Program Files. Тому на допомогу приходить домашній каталог користувача (чомусь на *nix ОС це нормально, а про те, що таке ж існує на Windows часто забувають). Отримати шлях до папки дуже просто:

import os
home_dir = os.path.expanduser('~')

В цю папку вже будь-який користувач зможе спокійно записувати все, що йому потрібно.