이미 작성해 둔 스크립트를 변환해 패키지를 시작해 보세요. 먼저 내 컴퓨터에서 사용할 수 있는 간단한 패키지를 만듭니다.

패키지 시작하기

모듈, 패키지, 서브패키지

스크립트에서 패키지로

패키지를 제대로 활용해 봅시다

문서화

pyment로 함수 문서 작성하기

pyment로 함수 문서 작성하기 II

패키지 및 모듈 문서화

임포트 구조화하기

형제 모듈 임포트

상위 패키지에서 가져오기

사용자에게 함수 공개하기

흩어진 코드에서 로컬 패키지로

본인과 다른 사람들이 설치할 수 있도록 패키지를 준비하세요. 이 장에서는 의존성 다루기, README 작성, 라이선스 포함 방법을 배우고, Python 패키지의 대표 배포처인 PyPI에 패키지를 게시하는 전 과정을 마칩니다.

내 패키지 설치하기

setup 스크립트 추가하기

패키지를 로컬에 설치하기

editable 설치 활용하기

의존성 다루기

사용자 종속성

개발 종속성

라이선스 포함하기와 README 작성하기

README 작성하기

MANIFEST - 패키지에 추가 파일 포함하기

패키지 게시하기

배포판 만들기

배포판 업로드하기

어디서든 패키지 설치하기

패키지를 전문가 수준으로 끌어올리세요. 오류를 방지하기 위한 pytest 사용법, 여러 Python 버전에서 패키지가 동작하는지 확인하는 tox, 그리고 멋진 코드 스타일을 유지하는 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 분류자(Classifier)

Makefile 사용하기

마무리

빠른 패키지 개발

파일 사이에서 같은 코드를 복사해 붙여 넣으며, 더 쉽게 재사용하고 공유할 수 있으면 좋겠다고 생각해 보신 적이 있나요? 코드를 Python 패키지로 감싸면 도움이 됩니다! 이 강의에서는 패키지 구조와, 흩어진 코드를 손쉽게 쓸 수 있는 패키지로 바꾸는 데 필요한 추가 파일들을 배웁니다. 또한 import 구조, 문서화, flake8로 코드 스타일을 유지하는 방법도 익힙니다. 이어서 템플릿을 만들어 개발 속도를 높이고, cookiecutter로 패키지 스켈레톤을 생성하는 방법을 다룹니다. 마지막으로 setuptools와 twine을 사용해 패키지를 빌드하고 PyPI—Python 패키지의 중심 무대—에 게시하는 방법을 배웁니다.

Introduction to Shell

Writing Functions in Python

패키지 구조, 문서화, 코드 스타일 유지 방법을 배우고 템플릿을 만들어 배포하세요.

Python 패키지 개발하기

자신만의 Python 패키지를 만들어 코드를 더 쉽게 사용하고 타인과 공유하는 방법을 학습하세요.

패키지 테스트하기

Create Your Free Account