Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 

파이썬 - PyPI 패키지 만들기 (3) entry_points 옵션

지난 글에 다룬,

파이썬 - PyPI 패키지 만들기
; https://www.sysnet.pe.kr/2/0/12863

파이썬 - PyPI 패키지 만들기 (2) long_description, cmdclass 옵션
; https://www.sysnet.pe.kr/2/0/12865

setup.py의 옵션 중에는 entry_points라는 것이 있습니다.

setup(
    name="net-util",
    description="utility functions for networking",
    long_description=readme(),
    long_description_content_type='text/markdown',
    # cmdclass={'sdist': UserCode},
    cmdclass={'bdist_wheel': UserCode},
    version=netutil.__version__,
    author=netutil.__author__,
    author_email="techsharer@outlook.com",
    url="https://www.sysnet.pe.kr",
    license="Ms-PL",
    packages=find_packages(exclude=[]),
    install_requires=["requests>=2.22.0"],

    entry_points={
        'console_scripts': [
            'netutil-admin = netutil.admin:main',
        ],
    },
)

위와 같이 지정한 경우라면, 당연히 "netutil.admin" 패키지가 있어야 합니다. 예를 들어 간단하게 다음과 같은 식의 파일을 만들 수 있습니다.

# ./netutil/admin/__init__.py


def main():
    print('net-util administrations')

그럼, "pip install ..." 시에 위의 "netutil.admin::main"을 호출하는 'netutil-admin.py'를 사용자 디렉터리($HOME/.local/bin)에 다음과 같은 식으로 pip 프로그램이 생성해 줍니다.

/home/testusr/.local/bin$ cat netutil-admin
#!/usr/bin/python3
# -*- coding: utf-8 -*-
import re
import sys
from netutil.admin import main
if __name__ == '__main__':
    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
    sys.exit(main())

따라서 일종의 프로그램을 하나 제공하는 효과를 얻게 되는데 실제로 해당 명령어를 실행하는 것도 가능합니다.

$ netutil-admin
net-util administrations

이렇게 만드는 경우 주의할 것이 있다면 바로, 해당 파일(위의 경우 __init__.py)에서 같은 프로젝트에 포함된 모듈을 import하는 경우 명시적으로 상대 경로를 지정해야 하는 상황도 있다는 점입니다.

예를 들어, __init__py와 동일한 디렉터리에 info.py가 있고,

# ./netutil/admin/info.py


def help_cmd():
    print('netutil-admin')
    pass

위의 기능을 이용하기 위해 단순히 __init__.py에서는 다음과 같이 사용할 수 있습니다.

# ./netutil/admin/__init__.py

import info


def main():
    print('net-util administrations')
    info.help_cmd()

하지만, 이것이 entry_points로 등록된 경우라면 상황이 달라집니다.

entry_points={
    'console_scripts': [
        'netutil-admin = netutil.admin:main',
    ],
},

저런 경우에는 netutil.admin 패키지에서 site-packages 경로를 기준으로 "import info"를 찾기 때문에 "ModuleNotFoundError: No module named 'info'"라는 예외가 발생합니다.

따라서, 상대 경로로 import를 해야 하는데 import 구문에는 상대 경로를 지정할 수 없으므로 sys.path.append를 이용하거나 다음과 같이 from 구문으로 바꿔 상대 경로를 지정하면 됩니다.

# ./netutil/admin/__init__.py

from .info import help_cmd


def main():
    print('net-util administrations')
    help_cmd()




entry_points로 등록한 경우 리눅스에서는 shell script로 "$HOME/.local/bin" 경로에 파일이 생성되는데, 그렇다면 윈도우의 경우에는 어떨까요?

개인적인 예상으로는 사실 지원하지 않을 거라고 생각했습니다. 왜냐하면, 윈도우의 경우 "%USERPROFILE%" 경로가 기본적으로 PATH 환경 변수에 등록되어 있진 않으므로 단순히 jennifer-admin.cmd 파일을 생성한다고 해서 실행되지는 않을 것이므로 여러모로 불편할 수 있습니다.

하지만, 지원을 합니다. ^^ 경로는, Python 설치 경로의 ".\Scripts\" 하위 디렉터리에 무려 EXE 파일로 생성이 됩니다. (cmd/bat가 아닌 굳이 왜 EXE로 했는지는 알 수 없지만!)

재미있는 것은, 윈도우 버전의 파이썬 Script 디렉터리에 있는 exe 파일들이,

pypi_adv_2.png

하나같이 104KB 크기로 된 것으로 봐서는 거의 템플릿화 되어 있는 듯합니다. 게다가 pip.exe 등도 결국 사용자가 컴파일해서 제공하는 것이 아닌, 결국 파이썬 모듈을 호출하는 console_scripts 설정으로 만들어진 실행 모듈이었던 것입니다. 그렇다면, 리눅스에서는 당연히 shell script로 연결된 것이라는 것을 유추할 수 있습니다. ^^

$ cat /usr/bin/pip
#!/usr/bin/python3
# EASY-INSTALL-ENTRY-SCRIPT: 'pip==20.0.2','console_scripts','pip'
__requires__ = 'pip==20.0.2'
import re
import sys
from pkg_resources import load_entry_point

if __name__ == '__main__':
    sys.argv[0] = re.sub(r'(-script\.pyw?|\.exe)?$', '', sys.argv[0])
    sys.exit(
        load_entry_point('pip==20.0.2', 'console_scripts', 'pip')()
    )




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 12/8/2021]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13186정성태12/6/202217오류 유형: 831. The framework 'Microsoft.AspNetCore.App', version '...' was not found.
13185정성태12/6/202239개발 환경 구성: 653. Windows 환경에서의 Hello World x64 어셈블리 예제 (NASM 버전)
13184정성태12/5/202276개발 환경 구성: 652. ml64.exe와 link.exe x64 실행 환경 구성
13183정성태12/4/202252오류 유형: 830. MASM + CRT 함수를 사용하는 경우 발생하는 컴파일 오류 정리
13182정성태12/4/202286Windows: 217. Windows 환경에서의 Hello World x64 어셈블리 예제 (MASM 버전)
13181정성태12/3/202281Linux: 54. 리눅스/WSL - hello world 어셈블리 코드 x86/x64 (nasm)
13180정성태12/2/202287.NET Framework: 2074. C# - 스택 메모리에 대한 여유 공간 확인하는 방법파일 다운로드1
13179정성태12/2/202254Windows: 216. Windows 11 - 22H2 업데이트 이후 Terminal 대신 cmd 창이 뜨는 경우
13178정성태12/1/2022146Windows: 215. Win32 API 금지된 함수 - IsBadXxxPtr 유의 함수들이 안전하지 않은 이유파일 다운로드1
13177정성태11/30/202298오류 유형: 829. uwsgi 설치 시 fatal error: Python.h: No such file or directory
13176정성태11/29/202274오류 유형: 828. gunicorn - ModuleNotFoundError: No module named 'flask'
13175정성태11/29/2022105오류 유형: 827. Python - ImportError: cannot import name 'html5lib' from 'pip._vendor'
13174정성태11/28/2022131.NET Framework: 2073. C# - VMMap처럼 스택 메모리의 reserve/guard/commit 상태 출력파일 다운로드1
13173정성태11/27/2022217.NET Framework: 2072. 닷넷 응용 프로그램의 스레드 스택 크기 변경
13172정성태11/25/2022267.NET Framework: 2071. 닷넷에서 ESP/RSP 레지스터 값을 구하는 방법파일 다운로드1
13171정성태11/25/2022223Windows: 214. 윈도우 - 스레드 스택의 "red zone"
13170정성태11/24/2022369Windows: 213. 윈도우 - 싱글 스레드는 컨텍스트 스위칭이 없을까요?
13169정성태11/23/2022382Windows: 212. 윈도우의 Protected Process (Light) 보안 [1]파일 다운로드2
13168정성태11/22/2022339제니퍼 .NET: 31. 제니퍼 닷넷 적용 사례 (9) - DB 서비스에 부하가 걸렸다?!
13167정성태11/21/2022331.NET Framework: 2070. .NET 7 - Console.ReadKey와 리눅스의 터미널 타입
13166정성태11/20/2022259개발 환경 구성: 651. Windows 사용자 경험으로 WSL 환경에 dotnet 런타임/SDK 설치 방법
13165정성태11/18/2022271개발 환경 구성: 650. Azure - "scm" 프로세스와 엮인 서비스 모음
13164정성태11/18/2022429개발 환경 구성: 649. Azure - 비주얼 스튜디오를 이용한 AppService 원격 디버그 방법
13163정성태11/17/2022280개발 환경 구성: 648. 비주얼 스튜디오에서 안드로이드 기기 인식하는 방법
13162정성태11/15/2022669.NET Framework: 2069. .NET 7 - AOT(ahead-of-time) 컴파일
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...