Bắt đầu gói của bạn bằng cách chuyển đổi các script bạn đã viết. Bạn sẽ tạo một gói đơn giản để dùng trên chính máy tính của mình.

Bắt đầu một package

Module, package và subpackage

Từ script đến package

Đưa gói của bạn vào sử dụng

Tài liệu

Viết tài liệu hàm với pyment

Viết tài liệu hàm với pyment II

Tài liệu cho package và module

Tổ chức import

Import giữa các mô-đun ngang hàng

Import từ thư mục cha

Cung cấp hàm cho người dùng

Từ mã rời rạc đến gói cục bộ

Giúp gói của bạn có thể cài đặt cho bạn và người khác. Trong chương này, bạn sẽ học cách xử lý dependencies, viết README và kèm giấy phép. Bạn cũng sẽ hoàn tất tất cả các bước để phát hành gói lên PyPI—ngôi nhà chính của các gói Python.

Cài đặt gói do bạn tự tạo

Thêm script setup

Cài đặt gói của bạn trên máy cục bộ

Tận dụng cài đặt dạng editable

Xử lý phụ thuộc

Phụ thuộc của người dùng

Các phụ thuộc cho phát triển

Thêm giấy phép và viết README

Viết README

MANIFEST - Bao gồm các tệp bổ sung trong gói của bạn

Xuất bản gói của bạn

Xây dựng bản phân phối

Tải lên các bản phân phối

Cài đặt gói của bạn từ bất cứ đâu

Đưa gói của bạn lên tiêu chuẩn chuyên nghiệp. Khám phá cách dùng pytest để ngăn lỗi, tox để kiểm tra gói chạy với nhiều phiên bản Python, và flake8 để giữ phong cách mã nhất quán.

Kiểm thử package của bạn

from impyrial.length.core import inches_to_feet, inches_to_yards


Tạo thư mục test

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


Viết một vài kiểm thử cơ bản

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


Chạy bộ kiểm thử của bạn

Kiểm thử gói của bạn trên các môi trường khác nhau

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


Thiết lập 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.*",
)


Chạy tox

Giữ cho gói của bạn chuẩn phong cách

Lọc cảnh báo về style một cách phù hợp

"""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


Dùng flake8 để dọn dẹp một tệp

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


Bỏ qua một số lỗi cụ thể

[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/*


Cấu hình flake8

Nâng cao chất lượng gói

Tạo gói nhanh hơn. Ở chương cuối, bạn sẽ học cách dùng cookiecutter để tạo mọi tệp hỗ trợ mà gói cần, dùng Makefile để đơn giản hóa việc phát hành phiên bản mới, và làm quen với vài tệp cuối cùng giúp gói của bạn thu hút người dùng và cộng tác viên.

Phát triển package nhanh hơn với template

Sử dụng mẫu package

Số phiên bản và lịch sử

CONTRIBUTING.md

Tệp lịch sử

Theo dõi số phiên bản với bumpversion

Makefile và classifiers

Classifier trên PyPI

Sử dụng makefile

Tổng kết

Phát triển gói nhanh chóng

Bạn có thường xuyên sao chép và dán cùng một đoạn mã giữa các tệp, ước gì có cách tái sử dụng và chia sẻ tiện hơn? Đóng gói mã của bạn thành các gói Python sẽ giúp ích rất nhiều! Trong khóa học này, bạn sẽ học về cấu trúc gói và các tệp bổ trợ cần có để biến mã rời rạc thành các gói tiện dùng. Bạn cũng sẽ học về cấu trúc import, viết tài liệu, và cách duy trì phong cách mã với flake8. Sau đó, bạn sẽ tăng tốc phát triển gói bằng cách xây dựng mẫu, dùng cookiecutter để tạo bộ khung gói. Cuối cùng, bạn sẽ học cách dùng setuptools và twine để build và phát hành gói của mình lên PyPI—“sân khấu” toàn cầu cho các gói Python.

Introduction to Shell

Writing Functions in Python

Tìm hiểu cấu trúc gói, nhập, tài liệu, duy trì phong cách mã, tạo mẫu và dùng công cụ để xuất bản.

Phát triển gói Python

Học cách tạo các gói Python của riêng bạn để làm cho mã nguồn của bạn dễ sử dụng và chia sẻ với người khác.

Giữ cho gói của bạn chuẩn phong cách

Create Your Free Account