Python 패키지 개발일지 01: 패키지 이름 정하기

혹시나 실수하거나 제대로 작동하지 않는 스크립트를 공유할까봐 전전긍긍하며 테스트를 하고, 그것들을 패키지로 묶어내느라 포스팅을 조금 쉬었습니다. 현재 윈도우즈 전용 자동화(매크로) 프로그램을 작성하는 도구인 AutoWinPy를 29번의 커밋 끝에 0.3.1 버전까지 올렸습니다. 오늘부터 잘못된 길로 들어선 부분을 들어낸 패키지 개발 일지를 공개하려고 합니다.

패키지 이름 짓기

비슷한 패키지 참고하기

패키지를 개발하려고 한다면 그 패키지가 파이썬 패키지 인덱스(PyPI)에서 유일한 이름을 가져야 합니다. 제 경우 우선 제가 목표로 하는 것과 비슷한 기능을 하는 비슷한 기능을 하는 몇 개의 패키지를 찾았습니다.

• Pywinauto
• PyAutoGUI
• Gui_automation

겹치지 않으며 패키지의 특성을 나타낼 수 있다고 생각하는 autowinpy로 정했습니다.

패키지 이름의 규칙과 관례

이름을 정할 때 다른 패키지를 참고하다가 보인 몇 가지 관례가 있는데요.

• 기본적인 규칙은 python의 식별자 규칙과 동일합니다.
• python 3.X의 패키지에는 대문자가 들어가지 않습니다.
• 띄어쓰기 대신 밑줄(_)을 사용하지만 그냥 단어를 붙여쓰는 경우가 훨씬 많았습니다.
• 설치시 사용하는 패키지 인덱스와 임포트(import)할 때의 이름이 다른 경우가 꽤 있었습니다(opencv, pywin32 등). 그러나 가급적 import {package} as {pack}문법을 사용할 것을 권합니다. 관리할 때와 사용할 때의 이름이 다르면 사용자들이 불편합니다.