Компания
124,31
рейтинг
14 января 2014 в 11:20

Разработка → Создание zip-модулей в python

Предыстория


На определенном этапе развития технологий компании Acronis было принято решение изучить возможность распространения интерпретатора языка python3 собственной сборки как часть наших продуктов, расширив его при этом нашими собственными модулями, обеспечивающими доступ к инфраструктуре этих продуктов. Данный пост является одним из результатов исследований в этом направлении.

В первую очередь, нам хотелось иметь ограниченный компактный набор конечных распространяемых модулей. Однако публичная сборка питона, распространяемая через python.org к этому не располагает, одна только стандартная библиотека, являющаяся неотъемлемой частью самого языка, состоит из более чем тысячи py-файлов. Именно поэтому, мы сразу обратили внимание на такую любопытную особенность интерпретатора, как возможность импорта модулей, находящихся в zip-архивах, когда все множество исходников на питоне, относящихся к одному или нескольким модулям, упаковано в zip-архив и распространяется одним zip-файлом.

Оглядываясь назад, можно с уверенностью сказать, что поддержка работы с zip-модулями в питон — мощная и удобная вещь. И она работает, причем работает хорошо. После ряда экспериментов с zip-модулями, проникнувшись духом zip-пекеджинга, мы настолько вошли во вкус, что всю стандартную библиотеку языка питон (скриптовую ее часть) также упаковали в отдельный zip-файл.

Начало


Для начала создадим тестовое окружение, максимально простое, но в то же время достаточное для демонстрации всех намеченных возможностей обсуждаемого функционала. Окружение будет виндовое, так уж мне оказалось в данный момент удобнее. Для желающих попробовать приведенные здесь примеры под линукс, просто отмечу, что принципиальных отличий быть не должно, единственное что требуется, это установленный python3, либо через пакетный менеджер вашего линуксового дистрибутива, либо через старый добрый configure/make/make install.

Простые демонстрационные модули, которые мы будем паковать в zip, у меня изначально размещены в d:\habr\lib:
  • say_hello.py
    def say_hello():
        print("Hello python world.")
    
  • my_sysinfo/__init__.py
    from .sysinfo import print_sysinfo
    
  • my_sysinfo/sysinfo.py
    import sys
    import traceback
    
    def print_sysinfo():
        print(80 * '-')
        print(sys.version)
        print(80 * '-')
        traceback.print_stack()
        print(80 * '-')
    

Поскольку среди прочего хотелось продемонстрировать возможность упаковки именно нескольких модулей в один zip-файл, здесь я создал два разнотипных модуля, первый модуль say_hello состоит из одного файла say_hello.py c заиммплеменченной в нем функцией say_hello(), второй модуль my_sysinfo сделан чуть более сложным – в виде директории с файлом __init__.py, содержащим в списке импорта функцию print_sysinfo. Забегая вперед, сразу скажу, что эта функция среди прочей сводной инфы типа sys.version также печатает стек собственного вызова именно для раскрытия особенностей zip-пекеджинга.

Проверяем, что все работает в неупакованном виде:
c:\Python33\python.exe

Python 3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path.insert(0,'d:\\habr\\lib')
>>> import say_hello
>>> say_hello.say_hello()
Hello python world.
>>> import my_sysinfo
>>> my_sysinfo.print_sysinfo()
--------------------------------------------------------------------------------
3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)]
--------------------------------------------------------------------------------
  File "<stdin>", line 1, in <module>
  File "d:\habr\lib\my_sysinfo\sysinfo.py", line 9, in print_sysinfo
    traceback.print_stack()
--------------------------------------------------------------------------------


Упаковка в zip


В самой упаковке исходных py-файлов в zip никаких секретов нет. Для этого можно воспользоваться любым доступным под рукой zip-архиватором, либо упаковать прямо питон-скриптом, воспользовавшись для этого функционалом из стандартного модуля zipfile. Чуть позже я приведу код простого скрипта упаковки, который я назвал mkpyzip.py и положил в папку d:\habr\tools.

Упаковываем этим скриптом приведенные выше модули в zip-файл d:\habr\output\mybundle.zip:
С:\Python33\python.exe d:\habr\tools\mkpyzip.py --src d:\habr\lib\my_sysinfo d:\habr\lib\say_hello.py --out d:\habr\output\mybundle.zip
::: d:\habr\lib\my_sysinfo\__init__.py >>> mybundle.zip/my_sysinfo/__init__.py
::: d:\habr\lib\my_sysinfo\sysinfo.py >>> mybundle.zip/my_sysinfo/sysinfo.py
::: d:\habr\lib\say_hello.py >>> mybundle.zip/say_hello.py
В этот скрипт среди прочего добавлен подробный вывод о том, какой файл и под каким именем упаковывается в zip-архив.

Проверяем, что все работает будучи упакованным в такой zip-архив:
c:\Python33\python.exe

Python 3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path.insert(0, 'd:\\habr\\output\\mybundle.zip')
>>> import say_hello
>>> say_hello.say_hello()
Hello python world.
>>> import my_sysinfo
>>> my_sysinfo.print_sysinfo()
--------------------------------------------------------------------------------
3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)]
--------------------------------------------------------------------------------
  File "<stdin>", line 1, in <module>
  File "d:\habr\output\mybundle.zip\my_sysinfo\sysinfo.py", line 9, in print_sysinfo
    traceback.print_stack()
--------------------------------------------------------------------------------
Из оутпута видно, что все работает как положено, будучи упакованным в zip-архив, в частности распечатка стека из нашей функции my_sysinfo.print_sysinfo() показывает, что код вызываемой функции находится внутри нашего zip-файла — d:\habr\output\mybundle.zip\my_sysinfo\sysinfo.py

Генерация байт-кода при упаковке в zip


А сейчас самое время вспомнить о такой хорошо известной особенности интерпретатора, как генерация байт-кода при импорте модуля, либо загрузка и выполнение байт-кода сгенерированного ранее, если таковой является валидным в момент импорта. В случае с модулями упакованными в zip, дела обстоят несколько иначе. Для zip-модулей байт-код должен быть сгенерирован и упакован в zip-файл заранее, иначе интерпретатор после каждого перезапуска при импорте любого модуля из zip-файла будет генерировать для него байт-код в памяти заново. Что ж, в нашем скрипте mkpyzip.py генерация байт-кода уже предусмотрена, просто добавим опцию --mkpyc и перегенерим zip-файл:
c:\Python33\python.exe d:\habr\tools\mkpyzip.py --mkpyc --src d:\habr\lib\my_sysinfo d:\habr\lib\say_hello.py --out d:\habr\output\mybundle.zip
::: d:\habr\lib\my_sysinfo\__init__.py >>> mybundle.zip/my_sysinfo/__init__.py
::: mkpyc for: d:\habr\lib\my_sysinfo\__init__.py >>> mybundle.zip/my_sysinfo/__init__.pyc
::: d:\habr\lib\my_sysinfo\sysinfo.py >>> mybundle.zip/my_sysinfo/sysinfo.py
::: mkpyc for: d:\habr\lib\my_sysinfo\sysinfo.py >>> mybundle.zip/my_sysinfo/sysinfo.pyc
::: d:\habr\lib\say_hello.py >>> mybundle.zip/say_hello.py
::: mkpyc for: d:\habr\lib\say_hello.py >>> mybundle.zip/say_hello.pyc

Теперь, когда раскрыты основные аспекты упаковки питон-модулей в zip-файл, самое время привести и код самой утилиты mkpyzip.py. Сразу отмечу, что ничего особенного в этом скрипте нет, а прототип для генерации байт-кода был позаимствован из стандартной библиотеки языка python (для поиска этого прототипа достаточно сделать поиск по ключевому слову wr_long).
mkpyzip.py
import argparse
import imp
import io
import marshal
import os
import os.path
import zipfile

def compile_file(filename, codename, out):
    def wr_long(f, x):
        f.write(bytes([x & 0xff, (x >> 8)  & 0xff, (x >> 16) & 0xff, (x >> 24) & 0xff]))
    with io.open(filename, mode='rt', encoding='utf8') as f:
        source = f.read()
        ast = compile(source, codename, 'exec', optimize=1)
        st = os.fstat(f.fileno())
        timestamp = int(st.st_mtime)
        size = st.st_size & 0xFFFFFFFF
        out.write(b'\0\0\0\0')
        wr_long(out, timestamp)
        wr_long(out, size)
        marshal.dump(ast, out)
        out.flush()
        out.seek(0, 0)
        out.write(imp.get_magic())

def compile_in_memory(source, codename):
    with io.BytesIO() as fc:
        compile_file(source, codename, fc)
        return fc.getvalue()

def make_module_catalog(src):
    root_path = os.path.abspath(os.path.normpath(src))
    root_arcname = os.path.basename(root_path)
    if not os.path.isdir(root_path):
        return [(root_path, root_arcname)]
    catalog = []
    subdirs = [(root_path, root_arcname)]
    while subdirs:
        idx = len(subdirs) - 1
        subdir_path, subdir_archname = subdirs[idx]
        del subdirs[idx]
        for item in sorted(os.listdir(subdir_path)):
            if item == '__pycache__' or item.endswith('.pyc'):
                continue
            item_path = os.path.join(subdir_path, item)
            item_arcname = '/'.join([subdir_archname, item])
            if os.path.isdir(item_path):
                subdirs.append((item_path, item_arcname))
            else:
                catalog.append((item_path, item_arcname))
    return catalog

def mk_pyzip(sources, outzip, mkpyc=False):
    zipfilename = os.path.abspath(os.path.normpath(outzip))
    display_zipname = os.path.basename(zipfilename)
    with zipfile.ZipFile(zipfilename, "w", zipfile.ZIP_DEFLATED) as fzip:
        for src in sources:
            catalog = make_module_catalog(src)
            for entry in catalog:
                fname, arcname = entry[0], entry[1]
                fzip.write(fname, arcname)
                print("::: {} >>> {}/{}".format(fname, display_zipname, arcname))
                if mkpyc and arcname.endswith('.py'):
                    bytes = compile_in_memory(fname, arcname)
                    pyc_name = ''.join([os.path.splitext(arcname)[0], '.pyc'])
                    fzip.writestr(pyc_name, bytes)
                    print("::: mkpyc for: {} >>> {}/{}".format(fname, display_zipname, pyc_name))

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('--src', nargs='+', required=True)
    parser.add_argument('--out', required=True)
    parser.add_argument('--mkpyc', action='store_true')
    args = parser.parse_args()
    mk_pyzip(args.src, args.out, args.mkpyc)

if __name__ == '__main__':
    main()


Валидность байт-кода


Добавлю также пару слов о том, как убедится в том, что сгенерированный нами байт-код валиден и интерпретатор нормально его подхватывает при импорте модуля без попыток перегенерации нового байт-кода в памяти.
Для этого просто распечатаем атрибут __file__, у заимпорченого модуля say_hello.
c:\Python33\python.exe

Python 3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path.insert(0,'d:\\habr\\output\\mybundle.zip')
>>> import say_hello
>>> say_hello.__file__
'd:\\habr\\output\\mybundle.zip\\say_hello.pyc'
То, что атрибут __file__ у загруженного модуля указывает на сгенерированный нами pyc-файл, является достаточным доказательством валидности нашего байт-кода.

На этом я бы наверное мог с чистой совестью закончить свой вводный обзор о zip-пекеджинге в языке питон, если бы не одно «но»…

Сюрпризы


Один из моих коллег как-то раз взял в руки Eclipse и с помощью хорошо известного к нему дополнения PyDev попытался заняться отладкой написанного им питон-скрипта, использовавшего среди прочего также и функционал и из питон-модулей зазипованых по только что описанной технологии.

Основной неприятный сюрприз заключался в том, что PyDev напрочь отказывался подобные модули дебажить. Сильно заинтересовавшись этой неприятностью мы начали искать первоисточник проблемы. Сейчас, оглядываясь уже назад, мы можем сказать, что по нашему личному убеждению в PyDev просто недостаточно качественная поддержка для отладки zip-модулей.

Тем не менее в момент исследования нюансы отладки под PyDev были сразу же исключены из рассмотрения, т.к. встроенный в питон отладчик pdb также выдавал информацию о стеке вызовов весьма сомнительного вида. Причем информация была сомнительной только в случае, когда в zip-архиве наравне с исходными py-файлами также находились и pyc-файлы с байт-кодом. В случае же zip-архива с одними только py-файлами автоматически генерируемый байт-код явно чем-то отличался, и отладка в pdb давала правильную информацию, не вызывавшую нареканий. За исключением отладки все работало как положено. И тем не менее с нашим байт-кодом было что-то определенно не то. И об этом нам явно сигнализировал pdb.

Теперь, когда первоисточник проблемы нами найден, вдаваться в детали отладки питон-кода под pdb уже не хочется. Чтобы пояснить причину проблемы, давайте просто заново распечатаем стек вызовов из зазипованого байт-кода, воспользовавшись написанной ранее функцией print_sysinfo() из модуля my_sysinfo.
c:\Python33\python.exe

Python 3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path.insert(0,'d:\\habr\\output\\mybundle.zip')
>>> import my_sysinfo
>>> my_sysinfo.print_sysinfo()
--------------------------------------------------------------------------------
3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)]
--------------------------------------------------------------------------------
  File "<stdin>", line 1, in <module>
  File "my_sysinfo/sysinfo.py", line 9, in print_sysinfo
    traceback.print_stack()
--------------------------------------------------------------------------------

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

Без байт-кода в zip-файле у нас был оутпут вида:
File «stdin», line 1, in «module»
File "d:\habr\output\mybundle.zip\my_sysinfo\sysinfo.py", line 9, in print_sysinfo
traceback.print_stack()

А после добавления байт-кода он принял вид:
File «stdin», line 1, in «module»
File "my_sysinfo/sysinfo.py", line 9, in print_sysinfo
traceback.print_stack()

Из оутпута становится четко видно, что при добавлении байт-кода в zip-архив в стеке вызовов путь к файлу из абсолютного пути превращается в относительный, причем относительный по отношению к корню zip-архива. Тут внимательный читатель может сразу возразить, что мы же сами сгенерировали такой байт-код, подав данный относительный путь в builtin-функцию compile в утилите mkpyzip.py. Но если об этом поразмыслить чуть глубже, то становится понятно, что полный то путь в данном случае никак не уместен, ибо конечная наша цель — это, собрав zip-архив на одной машине, иметь возможность использовать его на другой, возможно даже на машине с другой операционной системой.

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

В итоге было решено обратиться за советом к самим разработчикам языка питон через python-dev@python.org. Единственное, что они нам посоветовали на тот момент, это завести на эту тему баг, что бы не потерялся контекст описанной проблемы. Баг мы завели bugs.python.org/issue18307 и стали ждать. Примерно после месяца ожидания и занятий другими не менее насущными проблемами наше терпение тихо кончилось, и python33.dll попал в отладчик.

В итоге мы подтвердили наши подозрения и с определенностью можем утверждать, что именно Си-шная имплементация загрузчика zip-модулей в питон ведет себя некорректно при загрузке байт-кода. Точнее то, что описанный здесь случай, требующий автоматической нормализации путей в байт-коде при его загрузке из zip-файлов, был просто не реализован. В итоге в рамках этого же бага мы предложили патч, исправляющий данную проблему, и приводящий пути к файлам в стеках вызовов к абсолютному виду.

Сейчас, примерно пол-года спустя, данный баг на bugs.python.org остается открытым. Видимо потому, что zip-модули в питон — фича, хотя и мощная, но достаточно редко используемая, особенно случай с байт-кодом внутри zip-архива. Тем не менее, имея собственный репозитарий с исходниками питона (который мы по возможности стараемся держать максимально близким к публичному оригиналу), мы просто закоммитили к себе данный патч.

Заключение


Модули в питон, будучи запакованными в zip-архив, работают также хорошо, как и в неупакованном виде. Единственное к чему надо быть готовым, что после упаковки могут возникнуть определенные сложности с их отладкой как через Eclipse+PyDev, так и через другие IDE, отладка в которых также основана на PyDev. Тем не менее в определенных ситуациях возможность иметь компактное множество бинарных продакшн-модулей может оказаться значительно важнее легкой отладки питон-кода в IDE.

P.S. Мы изобрели setuptools/eggs? Нет.


Zip-модули в питон — это совершенно независимая и самодостаточная функциональность, заложенная в ядро самого интерпретатора языка. setuptools/eggs — это лишь самый широко известный вариант ее применения.
Автор: @vitaly-murashev
Acronis
рейтинг 124,31

Похожие публикации

Комментарии (14)

  • +5
    Прекрасная статья, спасибо за полезную информацию!

    И отдельное спасибо за то, что пользуетесь Питоном 3 на продакшне, ускоряя прогресс :-)
  • +4
    Вы изобрели setuptools и eggs, поздравляю :)
    • 0
      setuptools — это все-таки инструмент инсталляции новых модулей в питон.
      В этой статье просто хотелось рассказать, что сами модули, уже будучи установленными, могут находиться в zip-архивах.
      • 0
        Это не совсем правда. Setuptools — это в первую очередь не инсталляция модулей, а их сборка в яйца. И, да, каждое такое яйцо (оно собственно и является zip-архивом с метаданными) можно добавить в PYTHONPATH/sys.path и использовать. А можно ещё воспользоваться pkg_resources.Distribution и подключать в рантайме нужные яйца с нужными библиотеками, но это вам уже вряд ли нужно.
        • 0
          Все вами сказанное абсолютно верно.
          Просто когда я писал «инструмент инсталляции»,
          то установку в виде «яйца» я относил к одному из вариантов инсталляции модулей.
    • 0
      Позволю себе небольшое уточнение.
      zip-модули в питон мы не изобретали, они были изобретены самими разработчиками языка.
      Здесь просто рассказано как их создавать, и какие при этом могут возникнуть сложности
      • 0
        Я собственно о том же :) Мне кажется, что надо всё-таки логично и правильно в большинстве случаев делать это при помощи специально предназначенных инструментов. Я представляю себе ситуации, когда это может быть нужно делать руками (мне как раз это приходится делать), но, кажется, в вашем случае это не так.
        • 0
          Да, в нашем случае действительно все несколько иначе.

          Мы собираем zip-модули по описанной в статье схеме и складываем их в site-packages.
          плюс у нас настроен авто-импорт (расширение sys.path) для всех zip-файлов лежащих в site-packages.

          Поскольку мы рассматриваем нашу сборку питона как embedded-solution, которая прозрачно сосуществует (никак не конфликтуя и не пересекаясь) с любой другой официальной инсталляцией питона, мы можем себе такое позволить.
          • 0
            Главное, чтобы это все не сломало возможность использовать сторонние egg, и вообще пекеджи. Большой плюс питона как скриптового языка — именно в возможности использовать столько всего интересного с PyPI.
  • 0
    Если вы собираете свой собственный Питон — выложите символы к нему, пожалуйста, как это делается для официальных сборок. Они, бывает, пригождаются.
    • 0
      Спасибо, интересное предложение, мы его рассмотрим.
      Но на в данный момент релизов вместе с интерпретатором питона еще не было, только внутренние исследования.
  • 0
    С компилированием какой-то стрёмный велосипед получился. Есть же модули py_compile и compileall.
    • 0
      Если бы указанные вами модули обеспечивали необходимый фукционал по созданию модулей, упаковнных в zip-файл,
      мы бы непременно ими воспользовались. Так или иначе, код модуля py_comile дейстивительно послужил прототипом для представленной здесь утилиты mkpyzip.
      • 0
        Да, действительно, эти модули умеют компилировать только в непосредственно файл. Можно было в какой-нибудь временной папке скомпилировать и заархивировать директорию целиком. Дилемма — или дергать жесткий диск зря, или использовать код, который в новой реализации может сломаться :).

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

Самое читаемое Разработка