亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

PyInstaller?完美打包?Python?腳本

 更新時(shí)間:2023年06月06日 08:23:21   作者:淳帥二代  
PyInstaller?是一個(gè)用于將?Python?腳本打包成可執(zhí)行文件的工具,支持?Windows、Linux?和?macOS?等多個(gè)平臺。它可以將?Python?腳本及其依賴項(xiàng)打包成一個(gè)獨(dú)立的可執(zhí)行文件,方便用戶在沒有?Python?環(huán)境的機(jī)器上運(yùn)行程序。

引入問題

如果我要寫一個(gè) Python 項(xiàng)目,打包成 exe 運(yùn)行(方便在沒有 Python 的電腦上使用),我需要打包出的根目錄結(jié)構(gòu)美觀,沒有多余的、雜亂的依賴文件在那里礙眼,而且需要在發(fā)現(xiàn) bug 時(shí),我還需要能夠修改里面的代碼后,無需再次打包,就能正常運(yùn)行,該怎么做呢?

就以一個(gè) Hello 項(xiàng)目為例,記一下我找到的完美方法。

首先,新建項(xiàng)目文件夾,寫一個(gè) hello.py

用 PyInstaller 把 hello.py 打包,pyinstaller ./hello.py 命令會得到 builddist 文件夾,以及 hello.spec 文件:

其中:

build 文件夾是存放打包時(shí)臨時(shí)文件用的 dist 文件夾存放了打包好的應(yīng)用 hello.spec 內(nèi)容是 PyInstaller 根據(jù)我們的命令行生成的打包參數(shù)

打開 dist/hello 文件夾,可以看到我們打包好的 hello.exe 躺在一堆依賴文件之間,非常丑陋:

我們的目標(biāo),就是要把這些依賴包都移到一個(gè)子文件夾中,讓打包文件夾變得整潔,同時(shí)讓程序正常運(yùn)行。

最后我們可以打包成這個(gè)樣子:

首先,所有的依賴模塊都被移動到了 libs 文件夾,整個(gè)打包根目錄清清爽爽,只留下了必要的 python310.dllbase_library.zip。

其次,如你所見,這個(gè)程序的脾氣不是太好,出口成臟,我們希望用戶在拿到這個(gè)開源程序時(shí),可以修改腳本的內(nèi)容,不需要重新打包就能直接從 hello.exe 運(yùn)行。因此我們要把 hello.exe 做成程序入口,實(shí)際的邏輯寫在 hello_main.py ,同時(shí)要確保 hello_main.py 中的依賴都被正確打包到 libs 文件夾。

我們一步步解決。

第一步:自定義依賴包位置 生成 spec 文件

達(dá)到目的的關(guān)鍵在于用命令行打包時(shí)自動生成的 hello.spec ,它的本質(zhì)是一個(gè) python 文件,pyinstaller 有兩種運(yùn)行模式:

pyinstaller hello.spec 會使用 spec 文件中的配置進(jìn)行打包 pyinstaller hello.py <other args> 根據(jù)命令行參數(shù)自動生成 spec 文件,再依據(jù)使用 spec 文件中的配置進(jìn)行打包

pyinstaller 在打包時(shí),實(shí)際上是在做了一些準(zhǔn)備工作后,直接運(yùn)行了 spec 文件里的 Python 代碼。

相比于給命令行添加參數(shù),直接編輯 spec 文件,在里面保存參數(shù),更優(yōu)雅,更方便操作。

除了直接打包腳,本文件自動生成 spec 配置,還可以通過執(zhí)行 pyi-makespec hello.py 不打包,只生成 spec 配置。

解釋 spec 文件

打開 hello.spec 文件,有如下內(nèi)容(已作注釋):

# -*- mode: python ; coding: utf-8 -*-


block_cipher = None

# 這一部分負(fù)責(zé)收集你的腳本需要的所有模塊和文件。的;hiddenimports 參數(shù)可以指定一些 PyInstaller 無法自動檢測到的模塊。
a = Analysis(
    ['hello.py'],       # 指定要打包的 Python 腳本的路徑(可以是相對路徑)
    pathex=[],          # 用來指定模塊搜索路徑
    binaries=[],        # 包含了動態(tài)鏈接庫或共享對象文件,會在運(yùn)行之后自動更新,加入依賴的二進(jìn)制文件
    datas=[],           # 列表,用于指定需要包含的額外文件。每個(gè)元素都是一個(gè)元組:(文件的源路徑, 在打包文件中的路徑)
    hiddenimports=[],   # 用于指定一些 PyInstaller 無法自動檢測到的模塊
    hookspath=[],       # 指定查找 PyInstaller 鉤子的路徑
    hooksconfig={},     # 自定義 hook 配置,這是一個(gè)字典,一行注釋寫不下,此處先不講
    runtime_hooks=[],   # 指定運(yùn)行時(shí) hook,本質(zhì)是一個(gè) Python 腳本,hook 會在你的腳本運(yùn)行前運(yùn)行,可用于準(zhǔn)備環(huán)境
    excludes=[],        # 用于指定需要排除的模塊
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)
# 除此之外,a 還有一些沒有列出的屬性:
#   pure 是一個(gè)列表,包含了所有純 Python 模塊的信息,每個(gè)元素是一個(gè)元組,包含了:模塊名, pyc路徑, py 路徑,這些模塊會被打包到一個(gè) .pyz 文件中。
#   scripts 是一個(gè)列表,包含了你的 Python 腳本的信息。每個(gè)元素是一個(gè)元組,其中包含了腳本的內(nèi)部名,腳本的源路徑,以及一些元數(shù)據(jù)。這些腳本會被打包到一個(gè)可執(zhí)行文件中。


# pyz 是指生成的可執(zhí)行文件的名稱。它是由 PyInstaller 用來打包 Python 程序和依賴項(xiàng)的主要文件。


# 創(chuàng)建 pyz 文件,它在運(yùn)行時(shí)會被解壓縮到臨時(shí)目錄中,然后被加載和執(zhí)行。它會被打包進(jìn) exe 文件
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)


# 創(chuàng)建 exe 文件
exe = EXE(
    pyz,            # 包含了所有純 Python 模塊
    a.scripts,      # 包含了主腳本及其依賴
    [],             # 所有需要打包到 exe 文件內(nèi)的二進(jìn)制文件
    exclude_binaries=True,  # 若為 True,所有的二進(jìn)制文件將被排除在 exe 之外,轉(zhuǎn)而被 COLLECT 函數(shù)收集
    name='hello',   # 生成的 exe 文件的名字。
    debug=False,    # 打包過程中是否打印調(diào)試信息?
    bootloader_ignore_signals=False,
    strip=False,    # 是否移除所有的符號信息,使打包出的 exe 文件更小
    upx=True,       # 是否用 upx 壓縮 exe 文件
    console=True,   # 若為 True 則在控制臺窗口中運(yùn)行,否則作為后臺進(jìn)程運(yùn)行
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)


# 這個(gè)對象包含了所有需要分發(fā)的文件
# 包括 EXE 函數(shù)創(chuàng)建的 exe 文件、所有的二進(jìn)制文件、zip 文件(如果有的話)和數(shù)據(jù)文件
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='hello',   # 生成的文件夾的名字
)

加入 Hook

通過對 spec 文件的了解,我們知道了,可以在 a.runtimehooks 列表中加入 python 腳本 hook ,它會在我們的主代碼執(zhí)行之前運(yùn)行,為我們準(zhǔn)備環(huán)境。

在這個(gè) hook 里面,我們就可以修改 sys.path ,自定義 Python 查找模塊的路徑,或者環(huán)境變量

那我們就寫一個(gè) hook.py

import sys
from pprint import pprint

print(f'\n\n模塊查找路徑:')
pprint(sys.path)

print('\n')

然后,用 pyinstaller hello.spec 進(jìn)行打包,再執(zhí)行得到的 hello.exe,得到如下輸出:

可見 hook.py 確實(shí)在 hello.py 之前運(yùn)行了,且打印出了 sys.path ,即模塊查找路徑,有三個(gè):

dist/hello/base_library.zip 這個(gè)是程序所在目錄的 base_library.zip 文件 dist/hello/lib-dynload 這個(gè)是運(yùn)行程序時(shí)動態(tài)生成的 dist/hello/ 這個(gè)是程序所在目錄 hook 修改 sys.path

因此,我們就可以在打包輸出文件夾中新建一個(gè) libs 文件夾,將所有的依賴文件全都放進(jìn)去,然后在 hook.py 里把 libs 路徑加入 sys.path ,然后我們的腳本運(yùn)行時(shí)就正確搜索到依賴包了。

改寫 hook.py

import sys
from pathlib import Path
from pprint import pprint

BASE_DIR = Path(__file__).parent

for p in sys.path.copy():
    relative_p = Path(p).relative_to(BASE_DIR)
    new_p = BASE_DIR / 'libs' / relative_p
    sys.path.insert(0, str(new_p))

print(f'\n\n模塊查找路徑:')
pprint(sys.path)

print('\n')

然后,用 pyinstaller hello.spec 進(jìn)行打包,再執(zhí)行得到的 hello.exe,得到如下輸出:

從輸出可以看到模塊查找路徑,已經(jīng)修改成功,新增了 libs 文件夾。

既然模塊查找路徑添加成功。那我們就 手動 把所有的依賴文件都移動到 libs 子文件夾中,再運(yùn)行 hello.exe ,完美運(yùn)行:

需要注意的是:由于 hook 也是 python 腳本,運(yùn)行 hook 需要 python 環(huán)境,所以 python310.dllbase_library.zip 不能移動到 libs 文件夾中。

我用的 Python 版本是3.10,所以會有一個(gè) python310.dll,具體的文件名會隨你安裝的 Python 版本而變化

查看依賴目標(biāo)位置

雖然我們在打包后將依賴文件移動到 libs 文件夾,程序能正常運(yùn)行,但是我們肯定不希望每次打包都要 手動 移動一次。

實(shí)際上我們可以在 spec 文件中定義依賴文件和二進(jìn)制文件的存放位置。

pyinstaller 在執(zhí)行 spec 文件中的代碼時(shí),自動分析找到所需的依賴文件后,會把他們的目標(biāo)路徑和原始路徑寫到 a.binaries ,我們可以把它打印出來看一下。

修改 hello.spec 文件

# -*- mode: python ; coding: utf-8 -*-


block_cipher = None


a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)


from pprint import pprint
pprint(a.binaries)  # 打印 a.binaries


pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='hello',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=True,
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='hello',
)

然后,用 pyinstaller hello.spec 進(jìn)行打包過程中得到如下輸出:

[('api-ms-win-crt-runtime-l1-1-0.dll',
  'C:\\Portable_library\\java\\jdk-14.0.1\\bin\\api-ms-win-crt-runtime-l1-1-0.dll',
  'BINARY'),
 ('python310.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\python310.dll',
  'BINARY'),
 ('api-ms-win-crt-heap-l1-1-0.dll',
  'C:\\Portable_library\\java\\jdk-14.0.1\\bin\\api-ms-win-crt-heap-l1-1-0.dll',
  'BINARY'),
 ('VCRUNTIME140.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\VCRUNTIME140.dll',
  'BINARY'),
  # 剩下的項(xiàng)就省略了
  ]

可以看到,a.binaries 是一個(gè)列表,其中的元素是元組,元組有3個(gè)內(nèi)容:

依賴文件目標(biāo)路徑 依賴文件原始路徑 文件類型

我們只需要修改 a.binaries ,在目標(biāo)路徑前加上 libs 就可以了,同時(shí),要確保 python310.dllbase_library.zip 不被修改。

修改依賴目標(biāo)位置

編輯 hello.spec 文件:

# -*- mode: python ; coding: utf-8 -*-


block_cipher = None


a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)


import re
import os

# 用一個(gè)函數(shù)選擇性對依賴文件目標(biāo)路徑改名
def new_dest(package: str):
    if package == 'base_library.zip' or re.match(r'python\d+.dll', package):
        return package
    return 'libs' + os.sep + package

a.binaries = [(new_dest(x[0]), x[1], x[2]) for x in a.binaries]


# 打印 a.binaries,檢查依賴文件目標(biāo)路徑
from pprint import pprint
pprint(a.binaries)


pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='hello',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=True,
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='hello',
)

然后,用 pyinstaller hello.spec 進(jìn)行打包,再執(zhí)行得到的 hello.exe,得到如下輸出:

[('libs\\VCRUNTIME140.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\VCRUNTIME140.dll',
  'BINARY'),
 ('python310.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\python310.dll',
  'BINARY'),
 ('libs\\_decimal.pyd',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\DLLs\\_decimal.pyd',
  'EXTENSION'),
  # 剩下的省略了
 ]

得到了干凈的輸出目錄, hello.exe 也能夠正常運(yùn)行:

但是如你所見,這個(gè)程序脾氣不好,爆粗口,用戶可能會想要修改其中的代碼,但又不想配置環(huán)境、重新打包。

因此接下來我們就要把 hello.exe 作為程序入口,實(shí)際的邏輯寫在 hello_main.py ,同時(shí)確保 hello_main.py 中的依賴都被正確打包到 libs 文件夾。這樣,用戶就可以通過編輯 hello_main.py 來修改程序行為了。

第二步:打包可修改程序

制作入口

新建文件 hello_main.py ,將 hello.py 的代碼邏輯復(fù)制進(jìn)去,并且要稍作修改:

# coding: utf-8

from rich import print

def main(*args, **kwargs):

    print('[red]Hello mother fucker! ')
    input('按下回車?yán)^續(xù)')

if __name__ == "__main__":
    main()

然后修改 hello.py,將其制作成程序入口,調(diào)用 hello_main.py 中的 main 函數(shù):

# coding: utf-8

import hello_main

hello_main.main()

然后,用 pyinstaller hello.spec 進(jìn)行打包,但是我們會發(fā)現(xiàn),打包出的程序與之前一模一樣,雖然打包出的 hello.exe 能正常運(yùn)行,但是我們卻找不到 hello_main.py

查看被打包的 py 模塊

找不到 hello_main.py 的原因是,它被打包進(jìn)了 hello.exe 中,所有被引用到的 py 文件都會被打包進(jìn) exe 文件中。

我們回顧一下開頭 spec 文件中內(nèi)容的注釋:

# 除此之外,a 還有一些沒有列出的屬性:
#   pure 是一個(gè)列表,包含了所有純 Python 模塊的信息,這些模塊會被打包到一個(gè) .pyz 文件中。
#   scripts 是一個(gè)列表,包含了你的 Python 腳本的信息。這些腳本會被打包到一個(gè) exe 文件中。

hello.py 是主腳本,會被加到 a.scripts 列表中,進(jìn)而打包到 exe 中,hello_main.py 則是作為被導(dǎo)入的 py 模塊,被加到了 a.pure 列表,后序被打包到 pyz 中。我們可以編輯 hello.spec,在打包過程中顯示出有哪些 py 文件被打包了:

a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)
import re
import os
# 用一個(gè)函數(shù)選擇性對依賴文件目標(biāo)路徑改名
def new_dest(package: str):
    if package == 'base_library.zip' or re.match(r'python\d+.dll', package):
        return package
    return 'libs' + os.sep + package
a.binaries = [(new_dest(x[0]), x[1], x[2]) for x in a.binaries]
# 打印 a.pure,顯示哪些 py 文件被打包
from pprint import pprint
pprint(a.pure)
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
... # 后面的代碼省略了

然后,用 pyinstaller hello.spec 進(jìn)行打包,在輸出中可以搜索到:

[
...
 ('http.cookiejar',  '...\\Python310\\lib\\http\\cookiejar.py',  'PYMODULE'),
 ('hello_main',      'D:\\PyInstaller優(yōu)雅打包\\hello_main.py', 'PYMODULE'),
 ('rich',            '...Python310\\lib\\site-packages\\rich\\__init__.py','PYMODULE'),
 ...
 ]

hello_main 赫然在列。

阻止 py 模塊被打包

既然 hello_main.py 是因?yàn)楸蛔詣蛹尤氲?a.pure 列表導(dǎo)致被打包的,那我們就可以在 spec 文件中將它從 a.pure 中剔除。

此外,我們還需要將 hello_main.py 添加到 a.datas 列表中,將它作為普通文件被復(fù)制到打包文件夾,編輯 hello.spec

# -*- mode: python ; coding: utf-8 -*-


block_cipher = None


a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)

import re
import os

# 用一個(gè)函數(shù)選擇性對依賴文件目標(biāo)路徑改名,重定向到 libs 文件夾
def new_dest(package: str):
    if package == 'base_library.zip' or re.match(r'python\d+.dll', package):
        return package
    return 'libs' + os.sep + package

a.binaries = [(new_dest(x[0]), x[1], x[2]) for x in a.binaries]

# 將需要排除的模塊寫到一個(gè)列表(不帶 .py)
my_modules = ['hello_main', ]

# 將被排除的模塊添加到 a.datas
for name in my_modules:
    source_file = name + '.py'
    dest_file = name + '.py'
    a.datas.append((source_file, dest_file, 'DATA'))

# 篩選 a.pure
a.pure = [x for x in a.pure if x[0] not in my_modules]

# 打印 a.dates ,顯示哪些文件被復(fù)制到打包文件夾
from pprint import pprint
pprint(a.datas)

pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='hello',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=True,
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='hello',
)

此時(shí),hook.py 中的 print 語句可以刪掉了。

然后,用 pyinstaller hello.spec 進(jìn)行打包,輸出中得到:

[
 ('base_library.zip', 'D:\\PyInstaller優(yōu)雅打包\\build\\hello\\base_library.zip', 'DATA'),
 ('hello_main.py', 'hello_main.py', 'DATA')
]

同時(shí)也可以在打包輸出文件夾中看到 hello_main.py 了,并且程序能正常執(zhí)行:

編輯 py 后再運(yùn)行

現(xiàn)在,用戶就可以編輯 hello_main.py 后直接從 hello.exe 運(yùn)行了,不需要重新打包(需要引入新庫的情況除外)。

用戶終于可以動手把這個(gè)脾氣暴躁的程序教育成一個(gè)健康積極的程序了:

后記

此外,還可以進(jìn)一步修改 hello.spec ,進(jìn)而得到更完善的程序,例如導(dǎo)入額外的包、添加圖標(biāo)、添加其他資源。

這就是一個(gè)打包程序的模板了。

多虧有 ChatGPT 這一個(gè)知識淵博、毫無厭倦的老師,耐心的回答我提出的每一個(gè)細(xì)節(jié)問題,才能有這么一個(gè)完美的打包方案。

本文詳細(xì)介紹了如何使用 PyInstaller 打包 Python 腳本,并解決了一些常見的問題,如打包后程序無法運(yùn)行、缺少依賴項(xiàng)等。在使用 PyInstaller 進(jìn)行打包時(shí),需要注意一些細(xì)節(jié),如指定打包的入口文件、排除不必要的文件和目錄、處理依賴項(xiàng)等。此外,還介紹了如何使用 PyInstaller 進(jìn)行高級配置,如指定打包的圖標(biāo)、設(shè)置程序的版本號等??傊?,PyInstaller 是一個(gè)非常實(shí)用的工具,可以幫助 Python 開發(fā)者將自己的程序打包成獨(dú)立的可執(zhí)行文件,方便用戶在不同的平臺上運(yùn)行。

到此這篇關(guān)于PyInstaller 完美打包 Python 腳本的文章就介紹到這了,更多相關(guān)PyInstaller打包 Python內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • python opencv檢測目標(biāo)顏色的實(shí)例講解

    python opencv檢測目標(biāo)顏色的實(shí)例講解

    下面小編就為大家分享一篇python opencv檢測目標(biāo)顏色的實(shí)例講解,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2018-04-04
  • Numpy之文件存取的示例代碼

    Numpy之文件存取的示例代碼

    這篇文章主要介紹了Numpy之文件存取的示例代碼,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2018-08-08
  • 最新評論