把你已經寫好的指令碼轉成套件，為你的套件開個頭。你會建立一個簡單的套件，並可在自己的電腦上使用。

啟動一個套件

模組、套件與子套件

從指令碼到套件

讓你的套件派上用場

文件說明

使用 pyment 撰寫函式文件

使用 pyment 撰寫函式文件 II

套件與模組文件

匯入結構設計

同層匯入（Sibling imports）

從父層匯入

將函式提供給使用者

從零散程式碼到本機套件

讓你的套件可供你自己與他人安裝。在本章中，你會學到如何處理相依套件、撰寫 README，以及加入授權條款。你也會完成將套件發佈到 PyPI——Python 套件的主要家園——所需的全部步驟。

安裝你自己的套件

加入 setup 指令稿

在本機安裝你的套件

使用可編輯安裝

處理相依套件

使用者相依套件

開發相依套件

加入授權條款並撰寫 README

撰寫 README

MANIFEST－在套件中包含額外檔案

發佈你的套件

建立散佈套件

上傳發行檔

從任何地方安裝你的套件

把你的套件提升到專業水準。你將學會使用 pytest 防止錯誤、用 tox 測試套件是否能在多個 Python 版本下運作，以及用 flake8 維持良好的程式風格。

測試你的套件

from impyrial.length.core import inches_to_feet, inches_to_yards


建立測試目錄

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def ____():
	# Check that 12 inches is converted to 1.0 foot
    ____ ____(____) == 1.0 
    # Check that 2.5 feet is converted to 30.0 inches
    ____ ____(____, reverse=True) == ____


from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1.0 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30.0 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0


撰寫一些基本測試

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0
    


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 120  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 12.0  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


執行你的測試

在不同環境中測試你的套件

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


設定 tox

[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest
    


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    #python_requires="==____.*",
)


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.9.*",
)


執行 tox

讓你的套件更有型

適當的風格過濾

"""Main module."""

def absolute_value(num):
    """Return the absolute value of the number"""
    if num>=0: return num
    else:
    	return -num


"""Main module."""


def absolute_value(num):
    """Return the absolute value of the number"""
    if num >= 0:
        return num
    else:
        return -num


使用 flake8 清理檔案

import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # ____: ____
    return l


import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # noqa: E741
    return l


忽略特定錯誤

[flake8]

# Ignore F401 violations in the main __init__.py file
# per-file-ignores =
#     ____ : ____
        
# Ignore all violations in the tests directoory
# exclude = ____


from impyrial.length.api import (
    convert_unit,
    unit_to_mixed,
    mixed_to_unit,
)

def test_convert_unit():
    assert convert_unit(30, "ft", "in")==360.0
    assert convert_unit(30, "yd", "ft")==90.0
    assert convert_unit(10, "mi", "yd")==17600.0


[flake8]

# Ignore F401 violations in the main __init__.py file
per-file-ignores =
    impyrial/__init__.py: F401
        
# Ignore all violations in the tests directoory
exclude = tests/*


設定 flake8

提升你的套件品質

更快速地建立你的套件。在最後一章中，你會學到如何使用 cookiecutter 產生套件所需的各種支援檔案、利用 Makefile 簡化新版本釋出流程，並認識最後幾個能吸引使用者與貢獻者的必要檔案。

用樣板更快開發套件

使用套件樣板

版本號與變更歷史

CONTRIBUTING.md

版本歷史檔

使用 bumpversion 追蹤版本號

Makefile 與分類器

PyPI 分類標籤

使用 Makefile

總結

快速套件開發

你是否常把同一段程式碼在不同檔案間複製貼上，總希望能更容易重複使用與分享這些好用片段？把程式碼包裝成 Python 套件就能幫上忙！在本課程中，你會學到套件結構，以及把零散程式碼轉成好用套件所需的額外檔案。你也會學到匯入結構、文件撰寫，並使用 flake8 維持程式風格一致。接著，透過建立樣板並使用 cookiecutter 產生套件骨架，來加速你的套件開發。最後，你將學習如何使用 setuptools 與 twine 建置並發佈套件到 PyPI——Python 套件的全球舞台。

Introduction to Shell

Writing Functions in Python

了解套件結構、匯入結構、文件及維護代碼風格，然後建立模板並使用設置工具發布。

開發 Python 套件

學會建立自己的 Python 套件，讓你的程式碼更易於使用與分享。

適當的風格過濾

開發 Python 套件

動手互動練習