첫 번째 Python 라이브러리를 만드는 방법을 알아보세요! 이 게시물 시리즈에서는 Poetry를 사용하여 Python 라이브러리를 만들고 게시하는 과정을 안내합니다. 초기 구성부터 기본 기능 구현 및 테스트까지 모든 것을 다루는 작은 계산기 애플리케이션 구축부터 시작하겠습니다. 이 시리즈가 끝나면 PyPI에서 전 세계와 공유할 수 있는 라이브러리가 준비됩니다.

시란 무엇입니까?

Poetry는 Python 프로젝트를 위한 종속성 관리 및 패키징 도구입니다. 전통적으로 여러 도구가 필요한 많은 작업을 자동화하여 라이브러리와 애플리케이션을 만들고 유지 관리하는 프로세스를 단순화합니다. Poetry에는 프로젝트를 결정론적으로 관리하는 데 필요한 모든 도구가 함께 제공됩니다. 다음은 Poetry의 주요 장점 중 일부입니다:

• 프로젝트 빌드: 단일 명령으로 프로젝트를 쉽게 빌드하고 패키징합니다.
• 작업 공유: 작업을 PyPI에 게시하여 알리세요.
• 종속성 상태 확인: 단 하나의 명령으로 프로젝트의 종속성을 확인하세요.
• 종속성 해결: Poetry에는 철저한 종속성 해결 프로그램이 함께 제공되며, 솔루션이 있으면 항상 해결책을 찾습니다.
• 격리: Poetry는 구성된 가상 환경을 사용하거나 자체 시스템을 만들어 항상 시스템에서 격리됩니다.
• 직관적인 CLI: Poetry 명령은 직관적이고 사용하기 쉬우며 기본값을 구분하지만 구성이 가능합니다.

이러한 장점을 통해 Poetry는 Python 프로젝트 개발을 위한 강력하고 효율적인 도구로 돋보입니다.

Python 라이브러리를 시작하기 전에 무엇이 필요합니까?

코드 작성을 시작하기 전에 개발 환경을 설정해야 합니다. 모든 것이 준비되었는지 확인하는 단계는 다음과 같습니다.

파이썬 버전 확인

먼저 최신 버전의 Python이 설치되어 있는지 확인해야 합니다. 시스템에 설치된 Python 버전을 확인하려면 터미널에서 다음 명령을 실행하세요.

python --version

아직 Python이 설치되어 있지 않거나 업데이트가 필요한 경우 공식 Python 웹사이트에서 다운로드하여 설치할 수 있습니다.

시 설치

최신 버전의 Python이 설치되어 있는지 확인한 후 다음 단계는 Poetry를 설치하는 것입니다. 공식 문서에 설명된 지침에 따라 Poetry를 설치할 수 있습니다. 빠른 설치 명령은 다음과 같습니다.

curl -sSL https://install.python-poetry.org | python3 -

라이브러리 시작: 첫 번째 단계

1단계: Poetry를 사용하여 프로젝트 만들기

이제 Python과 Poetry가 설치되었으므로 계산기 프로젝트를 시작할 차례입니다. Poetry를 사용하면 간단한 명령으로 새 프로젝트를 쉽게 만들 수 있습니다.

프로젝트를 생성하려는 디렉터리로 이동하고 터미널에서 다음 명령을 실행합니다.

poetry new calculator
cd calculator

이 명령은 필수 폴더와 파일을 포함하는 새로운 프로젝트 구조를 생성합니다.

calculator/
├── README.md
├── calculator
│   └── __init__.py
├── pyproject.toml
└── tests
    └── __init__.py

생성된 구조를 이해해 보겠습니다.

• README.md: 프로젝트를 설명하는 문서 파일입니다.
• calculator/: 애플리케이션의 소스 코드가 포함된 폴더입니다.
• tests/: 단위 테스트용 폴더입니다.
• pyproject.toml: Poetry의 기본 구성 파일입니다.

2단계: 계산기 기능 구현

이제 Calculator/calculator.py 파일 내에 계산기 기능을 만들어 보겠습니다.

calculator/
├── calculator.py
├── __init__.py

calculator.py 파일을 열고 기본 계산기 기능을 구현합니다.

def add(a, b):
    return a   b

def subtract(a, b):
    return a - b

def multiply(a, b):
    return a * b

def divide(a, b):
    if b == 0:
        raise ValueError("Não é possível dividir por zero")
    return a / b

3단계: 계산기 기능 테스트

테스트는 소프트웨어 품질을 보장하고 버그 수정 및 코드 발전에 대한 신뢰성을 제공하는 데 필수적입니다. 이 예에서는 단위 테스트를 사용하여 계산기 기능을 검증합니다. 테스트 환경을 설정하고 몇 가지 테스트 사례를 작성하여 수학 연산이 올바르게 작동하는지 확인하겠습니다.

테스트 환경 구성

개발 종속성으로 pytest 추가 시작:

poetry add --dev pytest

이제 테스트 폴더 안에 test_calculator.py라는 파일을 만듭니다.

import pytest
from calculator.calculator import add, subtract, multiply, divide

def test_add():
    assert add(2, 3) == 5
    assert add(-1, 1) == 0
    assert add(0, 0) == 0
    assert add(-1, -1) == -2

def test_subtract():
    assert subtract(5, 2) == 3
    assert subtract(0, 0) == 0
    assert subtract(-1, 1) == -2
    assert subtract(-1, -1) == 0

def test_multiply():
    assert multiply(2, 3) == 6
    assert multiply(5, 0) == 0
    assert multiply(-1, 1) == -1
    assert multiply(-2, -3) == 6

def test_divide():
    assert divide(6, 2) == 3
    assert divide(5, 2) == 2.5
    assert divide(-10, 2) == -5
    with pytest.raises(ValueError):
        divide(4, 0)

마지막으로 다음 명령을 사용하여 테스트를 실행합니다.

poetry run pytest

4단계: GitHub에 게시

이제 애플리케이션에 대한 테스트가 완료되었으므로 GitHub에서 공유할 수 있도록 준비하겠습니다. GitHub에 프로젝트를 추가하려면 아래 단계를 따르세요.

1. GitHub에 저장소 만들기: GitHub로 이동하여 계산기용 새 저장소를 만듭니다.

2. 저장소에 프로젝트를 추가하세요:

• 아직 초기화되지 않은 경우 프로젝트 디렉터리 내에서 Git 저장소를 초기화합니다.

git init

• Git에 모든 파일을 추가하고 첫 번째 커밋을 수행합니다.

git add .
git commit -m "Initial commit"

• GitHub의 원격 저장소에 로컬 저장소를 연결합니다.

git remote add origin 

• GitHub에 파일을 업로드하세요.

git push -u origin main

이제 프로젝트가 GitHub에 있으며 다른 개발자와 공유하고 공동 작업할 준비가 되었습니다.

5단계: Pip 또는 Poetry를 통해 설치

라이브러리를 직접 설치하려면 다음 명령을 사용하세요.

• Pip을 통해:

pip install git https://github.com/seu_usuario/seu_repositorio.git

• 시를 통해:

poetry add git https://github.com/seu_usuario/seu_repositorio.git

다음은 무엇입니까?

튜토리얼의 첫 번째 부분에서는 Poetry를 사용하여 Python 라이브러리를 만드는 데 필수적인 기본 사항을 다룹니다. 개발 환경 설정부터 시작하여 pytest를 이용한 단위 테스트로 기본 계산기를 구현하고 프로젝트를 GitHub에 공유해 협업을 진행했습니다.

이 튜토리얼의 다음 부분에서는 표준 Python 패키지 저장소인 PyPI에 라이브러리를 게시하는 방법을 살펴보고 PyPI에서 직접 Poetry 또는 pip를 사용하여 설치하는 방법을 알아봅니다. 이렇게 하면 다른 개발자가 라이브러리를 더 쉽게 사용할 수 있을 뿐만 아니라 Python 커뮤니티와 통합하는 데에도 도움이 됩니다.

여기까지 오신 것을 축하합니다! Python 라이브러리를 만드는 것이 즐겁기를 바랍니다. 댓글로 질문이나 제안을 자유롭게 공유해 주세요. 이제 2부로 넘어가서 Python 커뮤니티와의 협력 여정을 계속해 보겠습니다.

참고자료

• Canal Eduardo Mendes(@Dunossauro) 처음부터 Python 패키지 만들기: 요구 사항에서 배포까지
• 시 문서
• 시: Python 패키지를 쉽게 빌드하기