Freezing Your Code

https://d33wubrfki0l68.cloudfront.net/39155010c31c8d7a71555a776792afffc74430bf/46336/_images/33907151034_e0a9e53402_k_d.jpg
“Freezing” your code is creating a single-file executable file to distributeto end-users, that contains all of your application code as well as thePython interpreter.

Applications such as ‘Dropbox’, ‘Eve Online’, ‘Civilization IV’, andBitTorrent clients do this.

The advantage of distributing this way is that your application will “just work”,even if the user doesn’t already have the required version of Python (or any)installed. On Windows, and even on many Linux distributions and OS X, the rightversion of Python will not already be installed.

Besides, end-user software should always be in an executable format. Filesending in .py are for software engineers and system administrators.

One disadvantage of freezing is that it will increase the size of yourdistribution by about 2–12 MB. Also, you will be responsible for shippingupdated versions of your application when security vulnerabilities toPython are patched.

Alternatives to Freezing

Packaging your code is for distributinglibraries or tools to other developers.

On Linux, an alternative to freezing is tocreate a Linux distro package(e.g. .deb files for Debian or Ubuntu, or .rpm files for Red Hat and SuSE.)

Todo

Fill in “Freezing Your Code” stub

Comparison of Freezing Tools

Solutions and platforms/features supported:

SolutionWindowsLinuxOS XPython 3LicenseOne-file modeZipfile importEggspkg_resources support
bbFreezeyesyesyesnoMITnoyesyesyes
py2exeyesnonoyesMITyesyesnono
pyInstalleryesyesyesyesGPLyesnoyesno
cx_FreezeyesyesyesyesPSFnoyesyesno
py2appnonoyesyesMITnoyesyesyes

Note

Freezing Python code on Linux into a Windows executable was only oncesupported in PyInstaller and later dropped.

Note

All solutions need a Microsoft Visual C++ to be installed on the target machine, except py2app.Only PyInstaller makes a self-executable exe that bundles the appropriate DLL whenpassing —onefile to Configure.py.

Windows

bbFreeze

Prerequisite is to install Python, Setuptools and pywin32 dependency on Windows.

  • Install bbfreeze:
  1. $ pip install bbfreeze
  • Write most basic bb_setup.py
  1. from bbfreeze import Freezer
  2.  
  3. freezer = Freezer(distdir='dist')
  4. freezer.addScript('foobar.py', gui_only=True)
  5. freezer()

Note

This will work for the most basic one file scripts. For more advanced freezing you will have to provideinclude and exclude paths like so:

  1. freezer = Freezer(distdir='dist', includes=['my_code'], excludes=['docs'])
  • (Optionally) include icon
  1. freezer.setIcon('my_awesome_icon.ico')
  1. Provide the Microsoft Visual C++ runtime DLL for the freezer. It might be possible to append your sys.pathwith the Microsoft Visual Studio path but I find it easier to drop msvcp90.dll in the same folder where your scriptresides.
  • Freeze!
  1. $ python bb_setup.py

py2exe

Prerequisite is to install Python on Windows. The last release of py2exe is from the year 2014. There is not active development.

  1. from distutils.core import setup
  2. import py2exe
  3.  
  4. setup(
  5. windows=[{'script': 'foobar.py'}],
  6. )
  1. $ python setup.py py2exe

PyInstaller

Prerequisite is to have installed Python, Setuptools and pywin32 dependency on Windows.

OS X

py2app

PyInstaller

PyInstaller can be used to build Unix executables and windowed apps on Mac OS X 10.6 (Snow Leopard) or newer.

To install PyInstaller, use pip:

  1. $ pip install pyinstaller

To create a standard Unix executable, from say script.py, use:

  1. $ pyinstaller script.py

This creates:

  • a script.spec file, analogous to a make file
  • a build folder, that holds some log files
  • a dist folder, that holds the main executable script, and some dependent Python libraries
    all in the same folder as script.py. PyInstaller puts all the Python libraries used in script.py into the dist folder, so when distributing the executable, distribute the whole dist folder.

The script.spec file can be edited to customise the build, with options such as:

  • bundling data files with the executable
  • including run-time libraries (.dll or .so files) that PyInstaller can’t infer automatically
  • adding Python run-time options to the executable
    Now script.spec can be run with pyinstaller (instead of using script.py again):
  1. $ pyinstaller script.spec

To create a standalone windowed OS X application, use the —windowed option:

  1. $ pyinstaller --windowed script.spec

This creates a script.app in the dist folder. Make sure to use GUI packages in your Python code, like PyQt or PySide, to control the graphical parts of the app.

There are several options in script.spec related to Mac OS X app bundles here. For example, to specify an icon for the app, use the icon=\path\to\icon.icns option.

Linux

bbFreeze

PyInstaller

原文: https://docs.python-guide.org/shipping/freezing/