py2exe使用方法 (含一些調試技巧，如壓縮email 類)

一、簡介

 

py2exe是一個將python腳本轉換成windows上的可獨立執行的可執行程序(*.exe)的工具，這樣，你就可以不用裝python而在windows系統上運行這個可執行程序。

 

py2exe已經被用於創建wxPython,Tkinter,Pmw,PyGTK,pygame,win32com client和server,和其它的獨立程序。py2exe是發佈在開源許可證下的。

 

 

二、安裝py2exe

 

從http://prdownloads.sourceforge.net/py2exe 下載並運行與你所安裝的Python對應的py2exe版本的installer，這將安裝py2exe和相應的例子；這些例子被安裝在lib\site-packages\py2exe\samples目錄下。

 

三、py2exe的用法

 

如果你有一個名爲helloworld.py的python腳本，你想把它轉換爲運行在windows上的可執行程 序，並運行在沒有安裝python的 windows系統上，那麼首先你應寫一個用於發佈程序的設置腳本例如mysetup.py，在其中的setup函數前插入語句 import py2exe 。

mysetup.py示例如下:

 

 

from distutils.core import setup
import py2exe

setup(console=["helloworld.py"])

 

 

如果顯示錯誤提示的話 “ msvcp90.dll: no such file or directory”

 

請嘗試下面的方法：

 

from distutils.core import setup
import py2exe

setup(
    console=["helloworld.py"],
    options = { "py2exe": { "dll_excludes": ["MSVCP90.dll"] } }
)

 

然後按下面的方法運行mysetup.py: （dos:  cmd => cd desktop => mysetup.py py2exe）
python mysetup.py py2exe

上面的命令執行後將產生一個名爲dist的子目錄，其中包含了helloworld.exe,python24.dll,library.zip這些文件。
如果你的helloworld.py腳本中用了已編譯的C擴展模塊，那麼這些模塊也會被拷貝在個子目錄中，同樣，所有的dll文件在運行時都是需要的，除了系統的dll文件。

dist子目錄中的文件包含了你的程序所必須的東西，你應將這個子目錄中的所有內容一起發佈。

默認情況下，py2exe在目錄dist下創建以下這些必須的文件：
1、一個或多個exe文件。
2、python##.dll。 
3、幾個.pyd文件，它們是已編譯的擴展名，它們是exe文件所需要的；加上其它的.dll文件，這些.dll是.pyd所需要的。
4、一個library.zip文件，它包含了已編譯的純的python模塊如.pyc或.pyo

上面的mysetup.py創建了一個控制檯的helloword.exe程序，如果你要創建一個圖形用戶界的程序，那麼你只需要將mysetup.py中的console=["helloworld.py"]替換爲windows=["myscript.py"]既可。

 

py2exe一次能夠創建多個exe文件，你需要將這些腳本文件的列表傳遞給console或windows的關鍵字參數。如果你有幾個相關聯的腳本，那麼這是很有用的。

運行下面個命令，將顯示py2exe命令的所有命令行標記。
python mysetup.py py2exe --help

 

Global options:
  --verbose (-v)  run verbosely (default)
  --quiet (-q)    run quietly (turns verbosity off)
  --dry-run (-n)  don't actually do anything
  --help (-h)     show detailed help message

Options for 'py2exe' command:
  --optimize (-O)       optimization level: -O1 for "python -O", -O2 for
                        "python -OO", and -O0 to disable [default: -O0]
  --dist-dir (-d)       directory to put final built distributions in (default
                        is dist)
  --excludes (-e)       comma-separated list of modules to exclude
  --dll-excludes        comma-separated list of DLLs to exclude
  --ignores             comma-separated list of modules to ignore if they are
                        not found
  --includes (-i)       comma-separated list of modules to include
  --packages (-p)       comma-separated list of packages to include
  --compressed (-c)     create a compressed zipfile
  --xref (-x)           create and show a module cross reference
  --bundle-files (-b)   bundle dlls in the zipfile or the exe. Valid levels
                        are 1, 2, or 3 (default)
  --skip-archive        do not place Python bytecode files in an archive, put
                        them directly in the file system
  --ascii (-a)          do not automatically include encodings and codecs
  --custom-boot-script  Python file that will be run when setting up the
                        runtime environment

usage: setup_py2exe.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
   or: setup_py2exe.py --help [cmd1 cmd2 ...]
   or: setup_py2exe.py --help-commands
   or: setup_py2exe.py cmd --help

 

四、指定額外的文件

 

一些應用程序在運行時需要額外的文件，諸如配置文件、字體、位圖。
如果在安裝腳本中用data_files可選項指定了那些額外的文件，那麼py2exe能將這些文件拷貝到dist子目錄中。data_files應包含一個元組(target-dir, files)列表，其中的files是這些額外的文件的列表。

示例如下：

 

PythonCode:  # mysetup.py

 

from distutils.core import setup
import glob
import py2exe

setup(console=["helloworld.py"],
      data_files=[("bitmaps",
                   ["bm/large.gif", "bm/small.gif"]),
                  ("fonts",
                   glob.glob("fonts\\*.fnt"))],
)

 

說明：data_files選項將創建一個子目錄dist\bitmaps，其中包含兩個.gif文件；一個子目錄dist\fonts，其中包含了所有的.fnt文件。

 

 

五、Windows NT services

 

你可以通過傳遞一個service關鍵字參數給setup函數來建造Windows NT services
,這個service參數的值必須是一個Python模塊名(包含一service類)的列表。

示例如下：

PythonCode:  # mysetup.py

 

from distutils.core import setup
import py2exe

setup(service=["MyService"])

 

所建造的可執行的service是可以通過在其後跟一定的命令行參數標記來自行安裝和卸載的。你可以通過在這個可執行的service(exe)後跟一-help參數來得到更多的幫助。

 

六、COM servers

 

你可以通過傳遞一個com_server 關鍵字參數給setup函數來建造Windows NT services
,這個service參數的值必須是一個Python模塊名(包含一個或多個COM server 類)的列表。

示例如下：

PythonCode:  # mysetup.py

 

from distutils.core import setup
import py2exe

setup(com_server=["win32com.server.interp"])

 

 

默認情況下，DLL和EXE servers被建造，你不需要它們的話你可以簡單的刪除它們。

一個標準的py2exe setup文件編寫

 

 

 -*- coding: cp936 -*-
from distutils.core import setup

import py2exe


includes = ["encodings", "encodings.*"]
#要包含的其它庫文件

options = {"py2exe":

    {"compressed": 1, #壓縮
     "optimize": 2,
     "ascii": 1,
     "includes":includes,
     "bundle_files": 1 #所有文件打包成一個exe文件 }
    }
setup(
    options = options,
    zipfile=None,   #不生成library.zip文件
    console=[{"script": "hello.py", "icon_resources": [(1, "hello.ico")] }]#源文件，程序圖標
    )

 

 

新 版本已經可以打包爲一個文件了，以前都是一堆dll,pyd的。具體的變化其實只有一個地方。就是options裏增加bundle_files項，值爲 1表示pyd和dll文件會被打包到exe文件中，且不能從文件系統中加載python模塊；值爲2表示pyd和dll文件會被打包到exe文件中，但是 可以從文件系統中加載python模塊。另外setup中使用zipfile=None可以不生成library.zip。

 

例如原來 的：

 

from distutils.core import setup
import py2exe
includes = ["encodings", "encodings.*"]
options = {"py2exe":
            {   "compressed": 1,
                "optimize": 2,
                "includes": includes,
            }
          }
setup(
    version = "0.1.0",
    description = "search panda",
    name = "search panda",
    options = options,
    windows=[{"script": "search.py", "icon_resources": [(1, "search.ico")] }],
    )

 

 

只需要改爲： 

 

from distutils.core import setup
import py2exe
includes = ["encodings", "encodings.*"]
options = {"py2exe":
            {   "compressed": 1,
                "optimize": 2,
                "includes": includes,
                "bundle_files": 1
            }
          }
setup(
    version = "0.1.0",
    description = "search panda",
    name = "search panda",
    options = options,
    zipfile=None,
    windows=[{"script": "search.py", "icon_resources": [(1, "search.ico")] }],

    )

 

 

 

比如，這裏我打包以前的DelphiCode2HTML的

 

# -*- coding: gbk -*-

from distutils.core import setup
import py2exe

includes = ["encodings", "encodings.*"]
options = {"py2exe":
                    {"compressed": 1,
                     "optimize": 2,
                     "ascii": 1,
                     "includes":includes,
                     "bundle_files": 1}
           }
setup(
    options = options,
    zipfile=None,
    name = "HelloGuys.",
    description = "this is a py2exe test",
    windows=[{"script": "F:\我的程序\Python\CSDN Code Edit\Code2Html.py",
              "icon_resources": [(1, "F:\書籍\我的圖標\圖標xp\Convert.ico")]
              }]
    )

 

 

下面列出他的一些 options

 

keyword	description
data_files	list of "data" files that you are going to need to run your executable such as .pngs, .jpgs

 

 

Py2exe extends Distutils setup keywords

 

In addition to the standard distutils setup keywords, the following py2exe keywords specify what and how to build.

keyword	description
console	list of scripts to convert into console exes
windows	list of scripts to convert into GUI exes
service	list of module names containing win32 service classes
com_server	list of module names containing com server classes
ctypes_com_server	list of module names containing com server classes
zipfile	name of shared zipfile to generate; may specify a subdirectory; defaults to 'library.zip'. If zipfile is set toNone , the files will be bundled within the executable instead of 'library.zip'.
options	dictionary { "py2exe": { "opt1": val1, "opt2": val2, ... } }

 

 

The options dictionary of py2exe

 

The option keyword takes the following set of dictionary key: value pairs. The dictionary "key" names and the "value" types are listed in the table below.

 

key	value
unbuffered	if true, use unbuffered binary stdout and stderr
optimize	string or int of optimization level (0, 1, or 2) 0 = don’t optimize (generate .pyc) 1 = normal optimization (like python -O) 2 = extra optimization (like python -OO) See http://docs.python.org/distutils/apiref.html#module-distutils.util for more info.
includes	list of module names to include
packages	list of packages to include with subpackages
ignores	list of modules to ignore if they are not found
excludes	list of module names to exclude
dll_excludes	list of dlls to exclude
dist_dir	directory in which to build the final files
typelibs	list of gen_py generated typelibs to include
compressed	(boolean) create a compressed zipfile
xref	(boolean) create and show a module cross reference
bundle_files	bundle dlls in the zipfile or the exe. Valid values for bundle_files are: 3 = don't bundle (default) 2 = bundle everything but the Python interpreter 1 = bundle everything, including the Python interpreter
skip_archive	(boolean) do not place Python bytecode files in an archive, put them directly in the file system
ascii	(boolean) do not automatically include encodings and codecs
custom-boot-script	Python file that will be run when setting up the runtime environment

 

 

 

Example:

 

setup(
        windows=['trypyglet.py'],
        options={
                "py2exe":{
                        "unbuffered": True,
                        "optimize": 2,
                        "excludes": ["email"]
                }
        }
)

 

 

 

For more information enter the following at the python command line:

 

 

>>> from distutils.core import setup
>>> help(setup)

 

注意 windows 的用法，他可以代替 console， 如果你要集成 wxpython 的時候，一定會用的 ！

 

 

更多請查看 http://www.py2exe.org/index.cgi/ListOfOptions

 

 

如果程序中含有email類，並且壓縮時出現類似 “ImportError: No module named multipart ” 的錯誤，你需要如下的設置：

 

 

1. 嘗試將Lib下的email包，複製到當前文件夾中

2. 把['emai'] 放入includes中

3. 把['email']放入packages中

4. 繼續運行py2exe

 

如：

 

from distutils.core import setup
import py2exe

includes = ["encodings", "encodings.*",'email']

options = {"py2exe":
            {   "compressed": 1,
                "optimize": 2,
                "includes": includes,
                "bundle_files": 1,
                "packages": ['email'],
                "dll_excludes": ["MSVCP90.dll"]
            }
          }
setup(
    version = "0.1.0",
    description = "3th",
    name = "For My Lover",
    options = options,
    zipfile=None,
    windows=[{"script": "love.py", "icon_resources": [(1, "roses.ico")] }],
    )