将您已经编写的脚本转换为包，开始着手构建。您将创建一个简单的包，并可在您自己的电脑上使用。

开始创建包

模块、包与子包

从脚本到包

让您的包真正发挥作用

文档

使用 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 包，让代码更易用，也更方便与他人共享。

保持您的包风格统一

Create Your Free Account