简体中文(ZH-CN) English(EN) 繁体中文(ZH-TW) 日本語(JA) 한국어(KO) Melayu(MS) Français(FR) Deutsch(DE)
ホームページ > バックエンド開発 > Python チュートリアル > 本文

独自の Python パッケージを作成する

WBOY
リリース： 2023-09-02 19:53:14
オリジナル
1521 人が閲覧しました

创建您自己的 Python 包

Python は優れたプログラミング言語であり、それ以上のものです。ただし、最大の弱点の 1 つはパッケージです。これは社会では周知の事実です。パッケージのインストール、インポート、使用、作成は長年にわたって改善されてきましたが、Python やその他のより成熟した言語の苦労から多くを学ぶことができる Go や Rust などの新しい言語にはまだ及びません。

このチュートリアルでは、独自のパッケージを構築して共有するために必要なすべてを学びます。 Python パッケージに関する一般的な背景情報については、「Python パッケージの使用方法」を参照してください。

パッケージ化プロジェクト

プロジェクトのパッケージ化は、Python モジュールと場合によってはその他のファイルの一貫したセットを取得し、それらを簡単に使用できる構造に組み込むプロセスです。他のパッケージへの依存関係、内部構造 (サブパッケージ)、バージョン管理、対象ユーザー、パッケージの形式 (ソース コードやバイナリ) などの要素を考慮する必要があります。

＃＃＃例＃＃＃

簡単な例から始めましょう。 conman パッケージは、構成を管理するためのパッケージです。複数のファイル形式と、

etcd

を使用した分散構成をサポートします。 パッケージの内容は通常、単一のディレクトリに保存されます (ただし、サブパッケージを複数のディレクトリに分割するのが一般的です)。場合によっては (この例のように) 独自の git リポジトリに保存されます。

ルート ディレクトリにはさまざまな構成ファイル (

setup.py

が必須であり、最も重要なファイル) が含まれており、パッケージ コード自体は通常、パッケージ名と同じ名前を持つサブディレクトリにあります。テストディレクトリ。 conman は次のようになります: リーリー ​

setup.py

ファイルを簡単に見てみましょう。これは、setuptools パッケージから setup() と find_packages() という 2 つの関数をインポートします。次に、引数の 1 つとして find_packages() を指定して setup() 関数を呼び出します。 リーリー ​ ＃＃＃これは正常です。 setup.py

ファイルは通常の Python ファイルであり、必要な操作を行うことができますが、その主な役割は、適切な引数を使用して

setup() を呼び出すことです。は、パッケージのインストール時にさまざまなツールによって標準的な方法で呼び出されます。次のセクションで詳しく説明します。 設定ファイル

setup.py

に加えて、ここに表示してさまざまな目的に使用できるオプションの構成ファイルがいくつかあります。

setup.py

setup()

この関数は、パッケージのインストールのさまざまな側面を制御し、さまざまなコマンドを実行するために、多数の名前付き引数を受け取ります。多くのパラメータは、パッケージをリポジトリにアップロードする際の検索とフィルタリングに使用されるメタデータを指定します。

name

: パッケージの名前 (および PyPI でのリスト方法)
  • バージョン: これは適切な依存関係管理を維持するために重要です
  • url: パッケージの URL (通常は GitHub または readthedocs URL
    • )
  • packages: 含める必要があるサブパッケージのリスト;
    • find_packages()
  • ここにヘルプを提供します setup_requires: ここで依存関係を指定します
  • test_suite: テスト中に実行するツール
  • long_description
    • ここでは、
README.md

ファイルの内容を設定します。これは、信頼できる情報源を 1 つにするためのベスト プラクティスです。 セットアップ.cfg

setup.py

このファイルは、さまざまなコマンドを実行するためのコマンド ライン インターフェイスも提供します。たとえば、単体テストを実行するには、次のように入力します: python setup.py test ​ リーリー setup.cfg は、

setup.py

に渡されるコマンドのオプションのデフォルトが含まれる ini 形式のファイルです。ここで、setup.cfg には、nosetests (テスト ランナー) のいくつかのオプションが含まれています。 リーリー ​ MANIFEST.in このファイルには、内部パッケージ ディレクトリの一部ではないが、それでも含める必要があるファイルが含まれています。これらは通常、Readme ファイル、ライセンス ファイルなどです。重要なファイルは requirements.txt

です。 pip はこのファイルを使用して、他の必要なパッケージをインストールします。

これは conman の

MANIFEST.in ファイルです: リーリー ​

依存関係

setup.py の

install_requires

セクションおよび

requirements.txt

ファイルで依存関係を指定できます。 Pip は、install_requires から依存関係を自動的にインストールしますが、requirements.txt ファイルからは依存関係をインストールしません。これらの要件をインストールするには、pip の実行時に明示的に指定する必要があります: pip install -rrequests.txt。 <p><code class="inline">install_requires 选项旨在指定主要版本级别的最低和更抽象的要求。 requirements.txt 文件用于更具体的要求，通常包含固定的次要版本。

这是conman的需求文件。您可以看到所有版本都已固定，这意味着如果其中一个软件包升级并引入破坏 conman 的更改，它可能会受到负面影响。

PyYAML==3.11
python-etcd==0.4.3
urllib3==1.7
pyOpenSSL==0.15.1
psutil==4.0.0
six==1.7.3
ログイン後にコピー
 

固定让您可预测且安心。如果许多人在不同时间安装您的软件包，这一点尤其重要。如果没有固定，每个人都会根据安装时间获得不同的依赖版本组合。固定的缺点是，如果您不跟上依赖项的开发，您可能会陷入某些依赖项的旧的、性能不佳甚至易受攻击的版本。

我最初在2014年写了conman，并没有太关注它。现在，在本教程中，我升级了所有内容，并且几乎每个依赖项都进行了一些重大改进。

发行版

您可以创建源发行版或二进制发行版。我将涵盖两者。

源分布

使用以下命令创建源发行版：python setup.py sdist。这是 conman 的输出：

> python setup.py sdist
running sdist
running egg_info
writing conman.egg-info/PKG-INFO
writing top-level names to conman.egg-info/top_level.txt
writing dependency_links to conman.egg-info/dependency_links.txt
reading manifest file 'conman.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'conman.egg-info/SOURCES.txt'
warning: sdist: standard file not found: should have one of README, README.rst, README.txt
running check
creating conman-0.3
creating conman-0.3/conman
creating conman-0.3/conman.egg-info
making hard links in conman-0.3...
hard linking LICENSE -> conman-0.3
hard linking MANIFEST.in -> conman-0.3
hard linking README.md -> conman-0.3
hard linking requirements.txt -> conman-0.3
hard linking setup.cfg -> conman-0.3
hard linking setup.py -> conman-0.3
hard linking conman/__init__.py -> conman-0.3/conman
hard linking conman/conman_base.py -> conman-0.3/conman
hard linking conman/conman_etcd.py -> conman-0.3/conman
hard linking conman/conman_file.py -> conman-0.3/conman
hard linking conman.egg-info/PKG-INFO -> conman-0.3/conman.egg-info
hard linking conman.egg-info/SOURCES.txt -> conman-0.3/conman.egg-info
hard linking conman.egg-info/dependency_links.txt -> conman-0.3/conman.egg-info
hard linking conman.egg-info/not-zip-safe -> conman-0.3/conman.egg-info
hard linking conman.egg-info/top_level.txt -> conman-0.3/conman.egg-info
copying setup.cfg -> conman-0.3
Writing conman-0.3/setup.cfg
creating dist
Creating tar archive
removing 'conman-0.3' (and everything under it)
ログイン後にコピー
 

如您所见，我收到一条关于缺少带有标准前缀之一的 README 文件的警告，因为我喜欢 Markdown，所以我有一个 README.md 。除此之外，还包括所有包源文件和附加文件。然后，在conman.egg-info目录中创建了一堆元数据。最后，创建一个名为 conman-0.3.tar.gz 的压缩 tar 存档，并将其放入 dist 子目录中。

安装这个包需要一个构建步骤（即使它是纯Python）。您可以正常使用 pip 安装它，只需传递包的路径即可。例如：

pip install dist/conman-0.3.tar.gz
Processing ./dist/conman-0.3.tar.gz
Installing collected packages: conman
  Running setup.py install for conman ... done 

Successfully installed conman-0.3
ログイン後にコピー
 

Conman 已安装到站点包中，可以像任何其他包一样导入：

import conman
conman.__file__
'/Users/gigi/.virtualenvs/conman/lib/python2.7/site-packages/conman/__init__.pyc'
ログイン後にコピー
 

轮子

Wheels 是一种相对较新的方式来打包 Python 代码和可选的 C 扩展。它们取代了鸡蛋的形式。轮子有几种类型：纯Python轮子、平台轮子、通用轮子。纯 Python 轮子是像 conman 这样的包，没有任何 C 扩展代码。

平台轮子确实有 C 扩展代码。通用轮子是纯 Python 轮子，兼容具有相同代码库的 Python 2 和 Python 3（它们甚至不需要 2 到 3）。

如果您有一个纯 Python 包，并且希望您的包同时支持 Python 2 和 Python 3（变得越来越重要），那么您可以构建一个通用构建，而不是为 Python 2 构建一个轮子，为 Python 构建一个轮子3.

Python 3 是当前受到积极支持的 Python 版本，不断更新、改进和社区支持；建议对所有新项目和迁移使用 Python 3。

如果你的包有C扩展代码，你必须为每个平台构建一个平台轮。轮子的巨大好处，特别是对于带有 C 扩展的软件包来说，是不需要在目标机器上提供编译器和支持库。该轮子已经包含一个内置包。所以你知道它不会构建失败，而且安装速度要快得多，因为它实际上只是一个副本。使用 Numpy 和 Pandas 等科学库的人可以真正体会到这一点，因为安装此类软件包过去需要很长时间，并且如果缺少某些库或编译器配置不正确，则可能会失败。

构建纯轮子或平台轮子的命令是：python setup.py bdist_wheel。

Setuptools——提供 setup() 函数的引擎——将自动检测是否需要纯轮子或平台轮子。

running bdist_wheel
running build
running build_py
creating build
creating build/lib
creating build/lib/conman
copying conman/__init__.py -> build/lib/conman
copying conman/conman_base.py -> build/lib/conman
copying conman/conman_etcd.py -> build/lib/conman
copying conman/conman_file.py -> build/lib/conman
installing to build/bdist.macosx-10.9-x86_64/wheel
running install 

running install_lib
creating build/bdist.macosx-10.9-x86_64
creating build/bdist.macosx-10.9-x86_64/wheel
creating build/bdist.macosx-10.9-x86_64/wheel/conman
copying build/lib/conman/__init__.py -> build/bdist.macosx-10.9-x86_64/wheel/conman
copying build/lib/conman/conman_base.py -> build/bdist.macosx-10.9-x86_64/wheel/conman
copying build/lib/conman/conman_etcd.py -> build/bdist.macosx-10.9-x86_64/wheel/conman
copying build/lib/conman/conman_file.py -> build/bdist.macosx-10.9-x86_64/wheel/conman
running install_egg_info
running egg_info
creating conman.egg-info
writing conman.egg-info/PKG-INFO
writing top-level names to conman.egg-info/top_level.txt
writing dependency_links to conman.egg-info/dependency_links.txt
writing manifest file 'conman.egg-info/SOURCES.txt'
reading manifest file 'conman.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'conman.egg-info/SOURCES.txt'
Copying conman.egg-info to build/bdist.macosx-10.9-x86_64/wheel/conman-0.3-py2.7.egg-info
running install_scripts
creating build/bdist.macosx-10.9-x86_64/wheel/conman-0.3.dist-info/WHEEL
ログイン後にコピー
 

查看dist目录，可以看到创建了一个纯Python的轮子：

ls -la dist
dist/
total 32
-rw-r--r--  1 gigi  staff   5.5K Feb 29 07:57 conman-0.3-py2-none-any.whl
-rw-r--r--  1 gigi  staff   4.4K Feb 28 23:33 conman-0.3.tar.gz
ログイン後にコピー
 

名称 conman-0.3-py2-none-any.whl 有几个组件：

  • 包名称
  • 软件包版本
  • Python版本
  • 平台版本，最后是“whl”扩展。

要构建通用包，您只需添加 --universal，如 python setup.py bdist_wheel --universal。

生成的轮子名为 conman-0.3-py2.py3-none-any.whl。

请注意，如果您创建通用包，您有责任确保您的代码实际上可以在 Python 2 和 Python 3 下运行。

使用 Toml

Toml（Tom's Obvious Minimal Language）是一种易于使用的配置文件格式，用于配置软件应用程序。尽管 setup.py 仍然被广泛使用和支持，PEP518 建议使用 pyproject.toml 文件而不是 setup.py 进行打包和分发。

让我们使用pyproject.toml创建一个名为 apex 的简单 Python 包，用于检查电池状态并在电池充满时显示一条消息。

创建一个名为 apex 的目录结构。在 apex 内，添加一个 pyproject.toml 和一个 README.md 文件。

.apex
├── pyproject.toml
└── README.md
ログイン後にコピー

在根 apex 目录中，创建一个名为 apex 的子目录，其中包含一个 __init__.py 文件以使其成为一个包和一个 battery.py 文件。您的项目目录现在应如下所示：

.
├── apex
│   ├── battery.py
│   └── __init__.py
├── pyproject.toml
└── README.md
ログイン後にコピー

使用 pip 安装 psutil 包。

pip install psutil
ログイン後にコピー

Psutil（进程和系统实用程序）是一个用于 Python 中进程和系统监控的跨平台库。 Psutil 可以检索有关系统上运行的进程的信息，例如状态、CPU 使用情况和内存使用情况。它还可以操纵系统进程。

在battery.py文件中，添加检查电池是否已充满的代码。

import psutil

def check_battery():
    battery = psutil.sensors_battery()
    plugged = battery.power_plugged
    percent = battery.percent

    if percent == 100 and plugged:
        print "Battery is full. Unplug your Charger"
    else:
        print "Battery is not yet full."

if __name__ == "__main__":
    message = check_battery()
    print(message)
ログイン後にコピー

pyproject.toml 文件包含包的元数据，包括：

  • 构建系统
  • 名称
  • 版本
  • 项目依赖项.

打开pyproject.toml并指定 setuptools 作为构建系统。

[build-system]
requires = ["setuptools","wheel"]
build-backend ="setuptools.build_meta"
ログイン後にコピー

指定包的名称、版本号和项目依赖项列表。现在 pyproject.toml 文件如下所示：

[build-system]
requires = ["setuptools","wheel"]
build-backend ="setuptools.build_meta"

[project]
name="apex"
version ="1.0.0"

[project-dependencies]
psutil ="5.9.5"
ログイン後にコピー

最后，在README.md文件中添加以下内容。

# apex

**apex** is a Python package that allows you to check the battery status of your laptop and display a message when the battery is full.

## Features

- Retrieve battery status information
- Display a message when the battery is full
- Cross-platform support (Windows, macOS, Linux, etc.)

## Installation

Install **apex** using `pip`:

```shell
pip install apex
ログイン後にコピー

使用 build 命令构建包。

 python -m build
ログイン後にコピー

您应该看到下面的输出，该输出已被我截断。 

creating build/bdist.linux-x86_64/wheel/apex-1.0.0.dist-info/WHEEL
creating '/home/vaati/Desktop/apex/dist/.tmp-d8_lqaaj/apex-1.0.0-py3-none-any.whl' and adding 'build/bdist.linux-x86_64/wheel' to it
adding 'apex/__init__.py'
adding 'apex/battery.py'
adding 'apex-1.0.0.dist-info/METADATA'
adding 'apex-1.0.0.dist-info/WHEEL'
adding 'apex-1.0.0.dist-info/top_level.txt'
adding 'apex-1.0.0.dist-info/RECORD'
removing build/bdist.linux-x86_64/wheel
Successfully built apex-1.0.0.tar.gz and apex-1.0.0-py3-none-any.whl
ログイン後にコピー

构建会创建一个 dist 文件夹，其中包含包的分发文件：

  • apex-1.0.0.tar.gz：apex 包的源发行版。它包含安装该软件包所需的源代码。
  • apex-1.0.0-py3-none-any.whl：apex 包的二进制发行版。您可以使用二进制发行版直接从源代码安装它。

构建过程还会生成一个 apex.egg-info 文件夹，其中包含有关包的元数据。

.
├── apex
│   ├── battery.py
│   └── __init__.py
├── apex.egg-info
│   ├── dependency_links.txt
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   └── top_level.txt
├── dist
│   ├── apex-1.0.0-py3-none-any.whl
│   └── apex-1.0.0.tar.gz
├── pyproject.toml
└── README.md
ログイン後にコピー

结论

编写自己的 Python 包需要处理大量工具，指定大量元数据，并仔细考虑您的依赖项和目标受众。但回报是巨大的。

如果您编写有用的代码并正确打包它，人们将能够轻松安装它并从中受益。

以上が独自の Python パッケージを作成するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

ソース：php.cn
前の記事：Python と PIL を使用して画像を圧縮するにはどうすればよいですか? 次の記事：配列内で指定された項目が最初に出現するインデックスを検索する Python プログラム
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
著者別の最新記事
最新の問題
function_exists() はカスタム関数を決定できません Function test () {return true;} if (function_exists ('test')) {echo "テストは関数です";
から 2024-04-29 11:01:01
0
2
1773
Google Chromeのモバイル版を表示する方法 こんにちは、先生、Google Chrome をモバイル版に変更するにはどうすればよいですか?
から 2024-04-23 00:22:19
0
10
1916
子ウィンドウは親ウィンドウを操作しますが、出力は応答しません。 最初の 2 つの文は実行可能ですが、最後の文は実装できません。
から 2024-04-19 15:37:47
0
1
1628
親ウィンドウには出力がありません document.onclick = function(){ window.opener.document.write('私は子ウィンドウの出力です');
から 2024-04-18 23:52:34
0
1
1539
CSS マインド マッピングに関するコースウェアはどこにありますか? コースウェア
から 2024-04-16 10:10:18
0
0
1574
関連トピック
詳細>
人気のおすすめ
人気のチュートリアル
詳細>
関連するチュートリアル
人気のおすすめ
最新のコース
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート
私たちについて 免責事項 Sitemap
PHP中国語ウェブサイト：福祉オンライン PHP トレーニング，PHP 学習者の迅速な成長を支援します！