Python 命令行可執行文件開發指南

一、概述

命令行是一種常用的外部接口形式，使人們可以使用計算機通過命令輸入來交互。Python是一種十分流行的編程語言，有時候開發人員可能需要將Python腳本轉化為命令行可執行文件，以便於其他人使用或者發布到其他平台上。本文章將會介紹如何在Python中創建命令行可執行文件，涉及到的技術包括argparse模塊、setup.py腳本以及distutils包等。

二、argparse模塊

argparse模塊是Python自帶用於命令行解析的庫，它能夠降低手動實現命令行解析的複雜度。該模塊的基本思路是：先創建命令行解析器對象，然後告訴解析器需要解析什麼參數以及如何解析參數，最後讓解析器解析命令行參數。下面是一個例子：

import argparse

def main():
    parser = argparse.ArgumentParser(description="示例命令行程序")
    
    parser.add_argument("--input", default="input.txt", help="讀取輸入文件名")
    parser.add_argument("--output", default="output.txt", help="寫入輸出文件名")
    parser.add_argument("--count", type=int, default=10, help="寫入行數")
    
    args = parser.parse_args()
    
    # 在這裡根據命令行的參數處理相應的邏輯
    print(args.input, args.output, args.count)
    
if __name__ == "__main__":
    main()

解析器對象首先被實例化，然後使用add_argument()方法來告訴解析器需要處理哪些參數，以及如何處理這些參數。上面的例子中，我們用了三個參數，其中–input和–output參數是字符串類型，–count參數是整數類型，同時還設置了默認值和help信息。最後，調用parse_args()函數解析命令行參數，parse_args()會返回一個對象，該對象包含了命令行參數的值，根據這些值來執行相應的邏輯。

三、setup.py腳本

setup.py腳本是Python包安裝和發布的標準腳本，它非常適合用於發布Python命令行可執行文件。本節將會演示如何使用setup.py腳本來打包Python命令行程序，使其可以在其他機器上運行。

首先，我們需要創建一個項目文件夾，並將Python代碼放入其中。例如，可以在該項目文件夾中創建一個名為sample.py的Python文件，它是我們要發布為可執行文件的腳本。接着，我們需要創建一個setup.py文件，該文件的主要作用是將Python代碼打包成可執行文件並安裝到目標機器上。

from setuptools import setup

setup(
    name="mysample",
    version="0.1",
    scripts=["sample.py"]
)

上面的代碼使用了setuptools庫來構建打包工具。我們需要給setup()方法一個包含所有必要信息的字典，如程序名稱（name）、版本（version）以及要打包的腳本文件（scripts）。運行命令“python setup.py bdist_wheel”會生成一個wheel格式的Python包，其中包含了我們的可執行文件。

四、distutils包

distutils是Python標準庫中的一個包，提供了發布Python代碼的一些基本工具，它與我們前面提到的setuptools有些類似，但它更加輕量級。在setup.py文件中，可以使用distutils來構建可執行文件。下面是一個例子：

from distutils.core import setup
from distutils.command.install_scripts import install_scripts

class my_install_scripts(install_scripts):
    def run(self):
        install_scripts.run(self)
        print("完成自定義腳本的安裝")

setup(
    name="mysample",
    version="0.1",
    py_modules=["sample"],
    cmdclass={
        "install_scripts": my_install_scripts
    },
    scripts=["mysample.py"]
)

上述代碼展示了如何使用distutils構建根據Python腳本創建的可執行文件。該代碼的關鍵在於設置了scripts屬性，以及使用了distutils提供的自定義命令類MyInstallScripts。MyInstallScripts類繼承自install_scripts類，重寫了run()方法，用於在腳本安裝完成後輸出一條信息。使用該自定義命令類可以使得腳本在安裝時自動運行一些額外的處理代碼。

五、結論

本文介紹了如何在Python中創建命令行可執行文件。要實現這一目標需要用到argparse模塊、setup.py腳本和distutils庫等技術。其中，argparse模塊是用於解析命令行參數的Python標準庫，setup.py腳本和distutils庫則可以將Python腳本打包成便於安裝和分發的可執行文件。相信通過本文的介紹，讀者可以更加熟練地掌握這些技術，從而更加有效地利用Python開發各種應用和工具。