Blog - Posts in Windows

파이썬 버전을 관리하는 PYENV

2024-05-10T00:00:00+09:00

파이썬 언어를 사용해 프로그램을 개발하다보면 프로그램이 배포되는 환경마다 제각기 다른 파이썬 버전을 사용하는걸 쉽게 볼 수 있습니다.

이런 경우 내 컴퓨터에 설치된 파이썬 버전과 프로그램이 배포되는 서버의 파이썬 버전을 맞추는 것이 가장 좋은 해결책이지만 윈도우를 제외한 리눅스나 맥은 운영체제에 파이썬이 기본으로 배포되어 배포 환경을 생각하지 않고 개발에 임하기 쉽습니다.

특히 리눅스의 경우 배포본이 최신에 가까울 수록 가장 최근에 배포된 파이썬 버전이 포함되기도 합니다. 필자의 사용하는 리눅스 [1] 컴퓨터만 해도 파이썬은 3.10.12 버전이 배포되어 있습니다. 맥의 경우 3.9 버전이 기본으로 배포되어 있습니다.

물론 윈도우는 파이썬과 파이썬으로 만든 프로그램이 사용되지 않기 때문에 파이썬이 기본으로 설치되어 있지는 않습니다.

상황이 이렇다보니 프로그램이 배포될 환경과 개발하는 환경의 파이썬 버전을 맞추는 것이 무엇보다 중요해졌습니다.

파이썬은 공식 웹 사이트 에서 필요로 하는 버전을 다운로드 받을 수 있습니다. 파이썬 웹 사이트에서 배포하는 파이썬 다운로드는 기본적으로 다음의 형태로만 다운로드 받을 수 있습니다.

소스 압축 파일 버전(gzip, xz)
맥용 설치 버전(pkg)
윈도우 인스톨러 버전(exe)
윈도우 임베디드 버전(zip)

지금 뭔가 이상한 부분을 발견하지 못하셨나요? 리눅스는 파이썬 웹 사이트에서 패키징된 파일을 제공하고 있지 않습니다. 이 때문에 리눅스에서 제공하고 있는 파이썬은 어디까지나 배포본을 만드는 사업자가 소스 코드를 다운로드 받아 컴파일해서 패키징 한것을 제공하고 있습니다.

그런데 어떤 파이썬 버전은 “소스 압축 파일 버전”만 제공하고 설치 파일은 제공하지 않는 경우도 있습니다. 이런 경우 해당 파이썬 버전을 반드시 써야 한다면 파이썬을 컴파일해서 사용할 수 밖에 없습니다.

참고

파이썬의 릴리즈 주기는 기본적으로 prerelease - bugfix - security - eol 단계로 구분됩니다.

prerelease - 공식 출시 직전
bugfix - 공식 출시는 되었지만 파이썬에 있는 버그를 수정
security - 보안 기능 패치(보안 버그가 있을 때만 제공)
eol - 더 이상 유지보수하지 않아 다운로드할 수는 있지만 쓰는 것은 권장하지 않음

파이썬 재단은 파이썬 출시에 있어 prerelease부터 bugfix 단계에 있는 버전들은 맥과 윈도우에서 실행 가능한 설치 파일을 제공하지만 security 단계부터는 소스 코드 압축 버전만 제공합니다.

소스 코드를 다운로드 받아 컴파일해서 사용하는 것은 2가지 어려움이 있습니다.

리눅스나 맥은 컴파일 환경 구축이 쉽지만 윈도우는 리눅스나 맥에 비해 컴파일 환경 구축이 상대적으로 어렵습니다.
소스 코드 컴파일도 어렵지만 컴파일 이후 설치 부터 삭제까지 전반적인 관리의 어려움이 생깁니다.

미리 컴파일된 파이썬 패키지를 제공하는 리눅스의 경우에도 모든 파이썬 버전의 패키징 파일을 제공하지 않기 때문에 특정 파이썬 버전이 필요하면 반드시 컴파일 단계가 필요합니다.

그래서 파이썬을 쉽게 컴파일하고 사용할 수 있도록 도와주는 버전 관리자가 필요합니다. 이 글에서는 파이썬 버전 관리자로 PyEnv를 다룹니다.

PyEnv 설치하기

pyenv는 POSIX 표준을 따르는 리눅스와 맥에서는 별도의 pyenv installer를 사용해서 설치할 수 있고 윈도우에서는 pyenv를 설치하고 사용할 수 없습니다. 윈도우에서 사용하려면 WSL에 올라간 리눅스에 설치하거나 Git Bash 등을 사용해야 합니다. 윈도우에서의 설치 방법은 차후 다룰 기회가 있을것입니다.

이 글에서 다루는 pyenv 개발 환경 구축은 맥과 데비안/우분투 계열의 리눅스 배포본에서의 설치 방법만 다룹니다.

pyenv를 설치하려면 운영체제에 git, curl이 설치되어 있어야 합니다.

데비안/우분투 계열 리눅스 배포본에 pyenv 설치하기

먼저 터미널 프로그램을 실행해서 셸을 시작합니다.

리눅스에 curl과 git이 설치되어 있지 않을 수 있으므로 다음 명령으로 설치해줍니다.

$ sudo apt install curl git

curl과 git이 설치되어 있지 않으면 pyenv 설치 중 bash: curl: command not found 메시지 또는 pyenv: Git is not installed, can't continue. 와 같은 메시지가 나타나고 pyenv 설치가 중단됩니다.

curl과 git을 설치했으면 pyenv 설치 명령을 입력합니다.

$ curl https://pyenv.run | bash

그럼 잠시 뒤에 설치 프로그램이 pyenv를 Github 저장소를 복제하면서 pyenv를 시스템에 설치해줍니다. 설치가 완료되면 마지막에 다음과 같은 내용이 셸에 출력됩니다.

WARNING: seems you still have not added 'pyenv' to the load path.

# Load pyenv automatically by appending
# the following to
# ~/.bash_profile if it exists, otherwise ~/.profile (for login shells)
# and ~/.bashrc (for interactive shells) :

export PYENV_ROOT="$HOME/.pyenv"
[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"

# Restart your shell for the changes to take effect.

# Load pyenv-virtualenv automatically by adding
# the following to ~/.bashrc:

eval "$(pyenv virtualenv-init -)"

이 메시지는 pyenv를 내랴받아 설치했으니 pyenv 명령을 어디서든 실행 가능하도록 PATH 환경 변수에 추가하고 pyenv 초기화 명령을 사용중인 셸의 설정 파일에 추가하라는 메시지입니다. 화면에 출력된 내용은 bash 셸의 설정 파일에 추가하는 내용입니다.

참고

셸의 설정 파일은 여러분이 사용하고 있는 셸에 파일명이 다릅니다. 사용중인 셸은 echo $SHELL 명령으로 확인합니다. 이 명령의 실행 결과가 bash로 끝나면 셸 설정 파일명은 .bashrc 이고, zsh로 끝나면 .zshrc 입니다.

다음 명령을 셸에 입력합니다.

echo 'export PYENV_ROOT="$HOME/.pyenv"' | tee -a ~/.bashrc
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' | tee -a ~/.bashrc
echo 'eval "$(pyenv init -)"' | tee -a ~/.bashrc

위 코드에서는 여러분이 bash 셸을 쓴다고 가정했지만 실제 사용하는 셸에 따라 셸 설정 파일명을 바르게 입력하시길 바랍니다.

이걸로 데비안/리눅스에서 pyenv 설치가 완료되었습니다.

맥에 pyenv 설치하기

맥은 Xcode Command Line Tools를 설치하면 curl과 git이 설치됩니다. 다음 명령으로 Xcode Command Line Tools를 설치합니다.

% xcode-select --install

이 명령이 실행되고 나면 프로그램을 설치할것인지 물어보는 화면이 표시되면 도구 설치에 동의하고 지나가면 됩니다.

이제 pyenv를 설치합니다.

% curl https://pyenv.run | bash

WARNING: seems you still have not added 'pyenv' to the load path.

# Load pyenv automatically by appending
# the following to
# ~/.bash_profile if it exists, otherwise ~/.profile (for login shells)
# and ~/.bashrc (for interactive shells) :

export PYENV_ROOT="$HOME/.pyenv"
[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"

# Restart your shell for the changes to take effect.

# Load pyenv-virtualenv automatically by adding
# the following to ~/.bashrc:

eval "$(pyenv virtualenv-init -)"

최근의 맥은 기본 셸 프로그램이 zsh 이므로 .zshrc 파일에 pyenv 초기화 명령들을 입력합니다.

echo 'export PYENV_ROOT="$HOME/.pyenv"' | tee -a ~/.zshrc
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' | tee -a ~/.zshrc
echo 'eval "$(pyenv init -)"' | tee -a ~/.zshrc

이제 터미널 프로그램을 다시 실행하면 pyenv를 사용할 수 있습니다.

pyenv를 사용하기

pyenv는 다양한 파이썬 버전을 설치하고 관리해주기 때문에 설치된 파이썬 버전 간의 전환 작업에 필요한 여러 명령을 알고 있어야 합니다.

여기에서는 pyenv 사용에 필요한 다음의 서브 명령을 살펴보겠습니다.

install
uninstall
shell
version
versions
which
whence
update

차례대로 pyenv 서브 명령이 어떤 일을 하는지 간략히 살펴보겠습니다.

install

pyenv를 실행중인 사용자 계정에 파이썬 인터프리터를 설치하는 명령입니다. 이 서브 명령은 -l 옵션 인자 또는 설치하려는 파이썬 버전을 인자로 받습니다.

pyenv로 설치 가능한 파이썬 인터프리터 종류는 계속 업데이트되고 있기에 여러분이 설치하려는 인터프리터 이름을 확인해두시는게 좋습니다. -l 옵션 인자를 주어 확인 가능합니다.

$ pyenv install -l

이 명령의 실행 결과로 매우 긴 내용이 화면에 출력됩니다. 이 중에 가장 처음에 출력되는 것은 2. 로 시작하는 것이 나오고 3. 으로 시작하는 것들과 알파벳으로 시작하는 파이썬 인터프리터 이름이 나오는데 여기에서 나오는 이름이 pyenv install 명령으로 설치할 수 있는 인터프리터 이름입니다.

2 또는 3으로 시작하는 숫자 버전은 C로 구현된 파이썬 버전을 말하며 python.org에서 공식적으로 배포되는 버전을 말합니다. pyenv는 공식 파이썬 버전 외에도 다양한 곳에서 배포되는 파이썬 인터프리터를 설치할 수 있으므로 여러분이 관심을 가지고 확인해보시면 좋을것 같습니다.

install 서브 명령은 기본적으로 설치하려는 파이썬 버전을 정확히 적어주는 것이 명확하지만 단순히 최신 버전을 설치하려고 하면 Major 버전 또는 Major.Minor 버전을 명시하는 방법으로도 설치할 수 있습니다.

예를 들어 다음과 같이 입력하는 식입니다.

파이썬 2.x의 최근 버전 설치하기

$ pyenv install 2

파이썬 3.10.x의 최근 버전 설치하기

$ pyenv install 3.10

이렇게 명령을 입력하는 것만으로 2.7.18 또는 3.10.14 버전의 소스 코드가 다운로드 되어서 실행됩니다.

install 명령은 파이썬 소스 코드를 다운로드 받아 컴파일을 진행하기 때문에 이 명령을 실행하기 전에 반드시 점검해야 하는 2가지 사항이 있습니다.

컴파일러에게 전달할 컴파일 옵션 등은 미리 운영체제 환경 변수로 저장해놓거나 인라인 환경 변수로 전달해야 합니다.
파이썬 소스 코드 컴파일에 필요한 시스템 라이브러리는 미리 설치해둡니다.

파이썬 소스 코드 컴파일러에 옵션을 제공해야 하면 PYTHON_CONFIGURE_OPTS 환경 변수를 install 서브 명령에 전달합니다.

install 서브 명령에 PYTHON_CONFIGURE_OPTS 환경 변수를 전달하는 방법은 다음의 두 가지 방법을 사용할 수 있습니다.

셸의 환경 변수로 만들면 pyenv가 환경 변수를 인식합니다.

$ export PYTHON_CONFIGURE_OPTS=--enable-shared
$ pyenv install 3.10

pyenv install 서브 명령을 실행하기 전에 가장 앞에 셸 환경 변수를 선언합니다.

$ PYTHON_CONFIGURE_OPTS=--enable-shared pyenv install 3.10

이 두 가지 방법 중에 어떤 방법을 사용해도 좋지만 필자는 인라인 방식으로 pyenv install 명령이 실행되는 동안에만 일시적으로 환경 변수가 살아있는 두 번째 방법을 선호합니다.

PYTHON_CONFIGURE_OPTS 환경 변수에 제공한 값은 pyenv가 파이썬 소스 컴파일을 하기 위해 내부적으로 실행하는 configure 스크립트에 인자로 전달됩니다.

여러분은 이 중에 편한 방식으로 사용하시면 됩니다.

운영체제 별로 파이썬 컴파일에 필요한 라이브러리 설치 방법이 달라지며 실제 설치는 뒤에서 다루겠습니다.

uninstall

uninstall 서브 명령은 pyenv install 서브 명령을 사용해 설치된 파이썬 버전을 지우는데 사용합니다.

$ pyenv uninstall 3.10

unintall 서브 명령에 전달하는 인자는 install 명령에 사용했던것과 동일해야 합니다. 설치되지 않은 것은 지울 수 없기 때문입니다.

shell

shell 서브 명령은 현재 사용중인 셸에서 실행할 파이썬 버전을 변경하는데 사용합니다. shell 서브 명령에 전달하는 인자는 install 서브 명령으로 설치된 파이썬 인터프리터 이름 입니다.

$ pyenv shell 3.10

shell 서브 명령이 사용되고 나면 python 명령이나 pip 등의 명령은 shell 서브 명령에 전달한 파이썬 인터프리터 경로의 명령이 실행됩니다.

단, shell 명령으로 변경된 파이썬 인터프리터는 셸이 동작하고 있는 터미널이 종료되면 해제됩니다. 이 글에서 다루진 않지만 셸이 종료되어도 특정 파이썬 인터프리터 버전을 유지하려면 local 서브 명령을 사용하면 됩니다.

version

version 서브 명령은 현재 셸에서 사용중인 파이썬 인터프리터 버전이 무엇인지 확인하는데 사용합니다. 다른 명령들과 이 명령은 인자를 받지 않습니다.

$ pyenv version

local 서브 명령이나 global 서브 명령 등이 사용되지 않았다면 터미널을 다시 실행했다면 system이 나올 것입니다.

versions

versions 서브 명령은 pyenv install 명령을 사용해 설치된 모든 파이썬 인터프리터 목록을 보는데 사용합니다. pyenv가 파이썬 가상 환경도 관리할 수 있기 때문에 pyenv로 가상 환경도 만들었다면 versions 서브 명령이 실행됐을 때 파이썬 가상 환경도 이름도 보여지게 됩니다.

$ pyenv versions

versions 서브 명령도 실행할 때 인자를 전달받지 않습니다.

which

which 서브 명령은 실행 인자를 받아 실행 인자로 주어진 명령이 실제 위치를 반환합니다. 예를 들어 shell 서브 명령에 실행 인자로 3.10.14를 주어 셸의 파이썬 환경을 바꿔줍니다. 그 다음 셸에서 python 명령을 입력했을 때 해당 명령이 어디에 있는지 찾으려면 다음과 같이 명령하면 됩니다.

$ pyenv which python

이 명령의 실행 결과는 /home/jiho/.pyenv/versions/3.10.14/bin/python 와 비슷한 형태로 표시됩니다.

whence

whence 서브 명령은 인자로 주어진 실행 파일의 이름이 pyenv 환경에 설치된 파이썬 환경 중에 어디에 설치되어 있는지 확인하기 위해 사용합니다. 예를 들어 3.10.13버전과 3.11.4 버전에 http 명령이 있고 3.9.8 버전에는 http 명령이 없는 상태에서 다음과 같이 명령을 입력하면 화면에는 3.10.13과 3.11.4만 나오게 됩니다.

$ pyenv whence http
3.10.13
3.11.4

특정 파이썬 환경에만 설치한 명령이 있는 경우 whence 서브 명령을 사용하면 pyenv로 설치한 파이썬 환경을 순회하면서 찾지 않아도 됩니다. 필자가 이 기능을 알았다면 좋았을 기능입니다.

update

update 서브 명령은 pyenv 자체를 업데이트 하는데 사용하는 명령이며 실행 인자를 받지 않습니다. pyenv는 설치되는 시점에 pyenv로 설치 가능한 파이썬 버전 정보가 디스크에 파일로 남기 때문에 pyenv를 업데이트 하지 않으면 새로 나온 파이썬 버전이 있을 경우 설치할 수 없습니다.

$ pyenv update

update 서브 명령은 자주 실행하지 않아도 되며 새로 나온 버전의 파이썬 인터프리터를 설치할 때만 사용하면 됩니다.

pyenv로 파이썬 설치하기

이제 본격적으로 pyenv로 파이썬을 설치해볼 차례입니다. 필자는 가능한 한 4개 정도의 마이너 파이썬 버전을 시스템에 설치해두길 권장합니다. 예를 들면 3.9부터 3.12까지 설치하는 것입니다. 이렇게 파이썬 버전을 여러개 설치하는 것을 권장하는건 개발중인 파이썬 프로그램이 사용하는 라이브러리 일부는 특정 마이너 버전이나 특정 패치 버전 이상을 요구하는 경우가 있기 때문입니다.

보통은 패치 버전까지는 라이브러리에서 가리지 않지만 마이너 버전까지는 일부 라이브러리가 설치 조건 등의 일부로 사용하기에 여러분도 이런 점을 감안하여 파이썬 인터프리터 버전을 설치해두시길 권장합니다.

데비안/우분투 계열 배포본에서 pyenv로 파이썬 설치하기

데비안/우분투 계열 배포본에서 파이썬을 컴파일 하려면 여러 시스템 라이브러리를 미리 설치해둡니다.

$ sudo apt install libbz2-dev libncurses-dev libreadline-dev libsqlite3-dev liblzma-dev tk-dev libffi-dev libssl-dev

이 다음엔 install 서브 명령으로 원하는 파이썬 버전을 설치하면 됩니다.

$ PYTHON_CONFIGURE_OPTS=--enable-shared pyenv install 3.10

필자는 pyenv로 파이썬을 컴파일 할 때는 항상 PYTHON_CONFIGURE_OPTS 환경 변수에 –enable-shared 값을 주는데 이 값은 설치하는 파이썬이 공유 라이브러리 모드로 컴파일되도록 합니다. 일부 파이썬 라이브러리는 파이썬이 공유 라이브러리 모드로 컴파일 되지 않으면 동작되지 않는 경우가 있기 때문입니다.

이제 잠시 기다리면 파이썬 컴파일이 완료됩니다. 파이썬은 설치했으니 다음엔 shell 서브 명령을 사용해 파이썬 인터프리터 버전을 지정하면 됩니다.

맥에서 pyenv로 파이썬 설치하기

맥의 경우 파이썬 컴파일에 필요한 라이브러리는 homebrew를 사용해 설치하는 것이 권장됩니다. homebrew를 설치하는 방법은 이 글에서 다루지 않으니 다른 문서를 참고해주세요.

homebrew가 설치되어 있다면 다음 명령으로 파이썬 컴파일에 필요한 라이브러리를 설치합니다.

% brew install bzip2  ncurses readline sqlite xz openssl@3

brew로 라이브러리를 설치하는 것은 조금 시간이 소요될 수 있으므로 느긋하게 기다리시길 바랍니다. brew로 라이브러리 설치가 완료되면 install 서브 명령으로 파이썬을 설치할 차례입니다.

% PYTHON_CONFIGURE_OPTS=--enable-shared pyenv install 3.10

파이썬 설치 명령은 리눅스와 동일하며 인자로 PYTHON_CONFIGURE_OPTS 환경 변수의 인자로 전달하는 것도 같으므로 이 부분은 가능한 꼭 기억해서 쓰시면 좋습니다.

마치며

이것으로 파이썬 버전을 쉽게 관리하고 쉽게 사용할 수 있게 하는 pyenv에 대한 소개를 마칩니다. 나머지 기능은 여러분이 직접 실습하면서 확인해보시길 바랍니다.

from. 파이썬 수다장이

각주

파이썬 CLI 프로그램 배포를 위한 최선의 선택! pipx

2024-05-08T00:00:00+09:00

파이썬으로 만들어진 프로그램을 배포한 후 실행하려면 크게 2가지 방법이 사용됩니다.

운영체제에서 바로 실행 가능한 형태로 변환하고 배포하기
파이썬 패키지 파일로 묶어서 배포하기

개별의 배포 방법은 배포하려는 파이썬 프로그램의 특징에 따라 다릅니다. 첫 번째로 살펴볼 “운영체제에서 바로 실행 가능한 형태로 변환하고 배포하기” 입니다.

일반적으로 파이썬으로 작성된 프로그램은 스크립트 파일 형태로 파이썬 인터프리터(python.exe)가 시스템에 설치되어 있어야만 실행할 수 있습니다.

여러분이 만든 파이썬 스크립트를 복사해서 다른 이에게 배포하면 십중팔구로 스크립트 파일을 전달받은 사람은 “이걸 어떻게 실행해?”라며 당황합니다.

이런 이유로 파이썬 스크립트를 다른 이에게 전달하기 이전에 배포받는 사람이 쉽게 실행할 수 있도록 exe 파일이나 맥이나 리눅스에서 실행 가능한 바이너리로 묶어서 배포해야 합니다.

여기에 사용하는 여러 파이썬 도구가 있으며 향후 소개하겠습니다.

두 번째로 살펴볼 “파이썬 패키지 파일로 묶어서 배포하기” 방법은 배포하려는 파이썬 프로그램이 라이브러리로서의 성격을 가지고 있거나 셸(shell)에서 바로 실행 가능한 파이썬 프로그램을 배포하기 위해서입니다.

파이썬 패키지 파일은 일반적으로 wheel 타입의 whl 확장자를 가진 파일이 배포되기 때문에 배포받는 사람의 컴퓨터에 파이썬 인터프리터가 설치되어 있어야 합니다.

드문 경우이긴 하지만 파이썬 패키지가 요구하는 최소 파이썬 버전이 시스템에 설치된 파이썬 버전보다 높은 경우 패키지 설치에 실패하기도 합니다.

콘솔 스크립트의 등장

파이썬은 패키지 파일을 설치하면서 패키지 파일 내부에 정의되어 있는 “콘솔 스크립트” 를 설치해주는 기능이 있습니다.

파이썬 패키지 파일 내부에 정의되어 있는 콘솔 스크립트는 패키지 파일에 포함되어 있는 특정 파이썬 스크립트를 배포하는 운영체제의 셸에서 바로 실행할 수 있도록 하는 기능입니다.

PEP 517-518에서 정의된 새로운 파이썬 패키징 규격에서는 콘솔 스크립트를 pyproject.toml 파일에 정의하도록 정의하고 있으며 대다수의 파이썬 패키징 도구가 이를 준수하고 있습니다.

콘솔 스크립트가 실제로 실행하는 파이썬 스크립트는 일반적으로 다음과 같은 구조를 가지고 있습니다. 예시로 sample이란 이름을 가진 콘솔 스크립트가 있다고 가정해보겠습니다.

sample.py

def main():
    print('sample 콘솔 스크립트가 실행되면 이 함수가 호출됩니다')

콘솔 스크립트는 파이썬 스크립트에 정의되어 있는 함수를 실행하기 때문에 파이썬 스크립트는 반드시 함수가 하나 선언되어 있어야 합니다.

콘솔 스크립트가 없다면 어떨까?

일반적으로 파이썬 스크립트를 셸에서 직접 실행하려면 if __name__ == ‘__main__’ 를 추가합니다.

만약 콘솔 스크립트 기능이 파이썬에 없으면 파이썬 스크립트를 실행하기 위해 항상 다음과 같이 명령을 실헹해야 합니다.

$ python sample.py

물론 위 명령을 실행하는 WD(Working Directory)에 sample.py가 있어야 하며 __name__ 이 __main__ 인지 비교한 후에 main 함수를 실행하는 코드가 있어야 합니다.

파이썬 스크립트를 직접 실행하는 방법은 간단하지만 스크립트를 실행하기 위해 항상 WD로 이동해야 한다는 단점은 치명적입니다.

콘솔 스크립트가 있다면?

파이썬 스크립트 파일을 콘솔 스크립트로 실행할 수 있게 되면 python 명령으로 직접 파일을 실행하지도 않으며 WD의 위치에 영향을 받지 않습니다.

다만, 파이썬 패키지 파일을 파이썬 가상 환경에 설치했다면 콘솔 스크립트도 셸의 실행 환경이 파이썬 가상 환경에 진입해 있어야만 실행 가능하다는 단점이 있습니다.

콘솔 스크립트를 파이썬 가상 환경에 구애받지 않고 쓰고 싶어요

파이썬으로 개발된 프로그램 중에는 여러 유용한 프로그램이 많습니다. 게중 유명한 것을 나열해보면 다음과 같은 것이 있습니다.

httpie (HTTPie 프로그램의 콘솔 스크립트 버전)
pipenv (파이썬 종속성 관리 도구)
poetry (파이썬 패키징 및 종속성 관리 도구)
certbot (LetsEncrypt 인증서 배포 도구)

이런 프로그램들은 일반적으로 WD에 영향을 받지 않고 어디서든 실행할 수 있는게 좋습니다. 따라서 시스템 전역의 파이썬 환경에 설치하는 것이 좋지만 PEP 668 의 제약이 있어 리눅스의 경우 시스템 전역의 파이썬 환경에 설치하는 것이 권장되지 않는 방식입니다.

PIPX 사용하기

그래서 pipx가 등장합니다. pipx는 pipsi와 npx에 영향을 받은 CLI 프로그램(콘솔 스크립트) 배포 도구 입니다.

pipx를 사용하면 앞의 httpie나 pipenv 같은 프로그램을 배포하기 위해 파이썬 가상 환경을 만들고 프로그램을 설치한 다음 실행하기 위한 단계가 줄어듭니다.

pipx 설치하기

pipx를 설치하려면 시스템에 파이썬 인터프리터가 설치되어 있어야 합니다. pipx를 운영체제에 설치하는 방법은 쉽습니다.

대다수 리눅스 배포본은 RPM이나 DEB 파일로 배포되고 있습니다. 윈도우와 맥은 pip 명령으로 설치하면 됩니다.

윈도우에 설치하기

이 글에서는 윈도우에 pipx를 설치하기 위해 Powershell을 사용합니다.

PS > Invoke-WebRequest -Uri https://bit.ly/4ctb7ek | iex
PS > Invoke-WebRequest -Uri https://bit.ly/3y1qTgL | iex
PS > Add-EnvPath $Env:AppData\$PY_VER\Scripts User
PS > pip install pipx
PS > pipx ensurepath

이렇게 하고 Powershell을 닫았다가 다시 시작하면 pipx 명령을 사용할 수 있습니다.

맥에 설치하기

맥에서는 단순히 pipx를 설치하고 실행하면 됩니다.

% pip install pipx
% pipx ensurepath

이것으로 설치가 끝납니다.

리눅스에 설치하기 (데비안/우분투 계열 배포본)

데비안/우분투 계열의 리눅스 시스템이라면 다음 명령으로 쉽게 설치할 수 있습니다.

$ sudo apt install pipx
$ pipx ensurepath

이 방법의 단점은 최신의 pipx 버전이 설치되지 않는다는 것입니다.

리눅스에 설치하기 (레드햇 계열 배포본)

이 방법은 레드햇 계열(Fedora, CentOS, RockyLinux 등)에 공통적으로 사용합니다.

레드햇 계열 배열 배포본에서는 pipx를 설치하기 위해 epel-release 저장소를 먼저 설치해야 합니다.

$ sudo dnf install epel-release
$ sudo dnf install pipx
$ pipx ensurepath

데비안/우분투 계열과 마찬가지로 레드햇 계열 배포본에서 기본 제공되는 pipx는 과거 버전이 제공됩니다.

리눅스 배포본에 설치되는 pipx 버전이 낮더라도 안심하셔도 됩니다. 리눅스의 경우 새 배포본 버전이 발표되면 pipx 버전도 업그레이드 되기 때문이기도 하지만 배포본에 제공되는 버전은 가장 안정화된 버전이 공급되기 때문입니다.

pipx를 사용해 httpie와 certbot 설치해보기

pipx를 설치했으니 이제 pipx를 사용해 httpie나 certbot을 설치해보겠습니다. (셸 프롬프트는 편의상 $로 표기하겠습니다)

$ pipx install httpie
$ pipx install certbot

pipx를 사용해 패키지 설치가 끝나면 셸에서 http 명령과 certbot 명령을 실행해보시길 바랍니다.

pipx의 현재 단점이 하나 있는데 한 번에 하나의 명령만 설치 가능합니다. 어떤 파이썬 패키지는 콘솔 스크립트가 여러개 일수도 있는데 pipx는 이런 경우에 파이썬 패키지 파일 내부에 정의되어 있는 모든 콘솔 스크립트를 셸에서 실행할 수 있도록 해줍니다.

마치며

pipx는 지금까지 살펴본 것처럼 파이썬 패키지 파일에 정의되어 있는 콘솔 스크립트를 우리가 셸에서 WD에 상관없이 사용할 수 있기 때문에 매우 유용합니다.

파이썬 CLI 프로그램을 배포하는 새로운 방법인 pipx! 꼭 한번 사용해보시길 바랍니다.

from. 파이썬 수다장이

파이썬으로 윈도우 서비스 만들기

2024-04-30T00:00:00+09:00

윈도우나 리눅스와 같은 운영체제는 운영체제 시작과 함께 백그라운드로 동작하는 프로그램이 있습니다. 일반적으로 이런 프로그램이 하는 일은 운영체제가 시작하면서 반드시 해야 하는 일이 많습니다. 예를 들면 네트워크 통신을 할 수 있도록 통신 기능을 활성화하거나 웹 페이지나 데이터베이스 서버 프로그램을 실행하는 기능을 가지고 있습니다.

리눅스와 맥은 이렇게 시작되는 프로그램을 데몬(Daemon)이라고 하고 윈도우는 서비스(Service)라고 합니다.

제가 이 글을 작성하게 된 것은 Trac(https://trac.edgewall.org) User 메일에 올라온 다음 메일 때문이었습니다.

Hi all,
Does anyone have experience with running trac as a windows service?

I've tried various methods including the python script provided in trac hacks, .bat files etc.

The issue I hit is that it starts trac ok, but stopping it stops the service but tracd keeps running in the background thus trac doesn't stop.

Any thoughts on how to fix this or working examples would be appreciated. Just need a way to ensure trac starts and stops as a service rather than just using cmd. Stand alone server btw.

tracd 명령으로 윈도우에서 시작했는데 tracd를 실행한 터미널을 종료했음에도 tracd가 종료되지 않는데 어떻게 하면 좋을지에 대한 의견을 구하는 것이었습니다.

그래서 직접 만들어 보기로 했습니다.

윈도우가 시작하면서 실행하는 많은 서비스가 있지만 여기서 그 서비스를 다 설명할 것은 아니고, 이 글에선 파이썬으로 윈도우 서비스를 만들고 동작시키는 방법을 살펴보겠습니다.

준비물

이 글을 시작하기에 앞서 다음과 같은 준비가 필요합니다.

윈도우 10 이상
파이썬 3.9 이상
명령 프롬프트 또는 파워셸

파이썬은 https://www.python.org 에서 배포하는 python-버전-amd64.exe 실행 파일로 설치되어 있고 Python 실행 경로가 PATH 환경 변수에 포함되어 있어야 합니다.

파이썬 유틸리티 설치

이 문서의 내용을 따라하기 위해 몇 가지 파이썬 프로그래밍 유틸리티 설치가 필요합니다. 설치할 유틸리티는 pipx와 pipenv 입니다.

PS > Invoke-WebRequest -Uri https://bit.ly/4ctb7ek | iex
PS > Invoke-WebRequest -Uri https://bit.ly/3y1qTgL | iex
PS > Add-EnvPath $Env:AppData\$PY_VER\Scripts User

이 명령의 실행이 끝나면 다음과 같이 pipx를 설치합니다.

PS > pip install pipx
PS > pipx ensurepath

이 명령의 실행이 끝나면 파워셸을 종료했다가 다시 실행합니다. 파워셸을 다시 실행했으면 pipenv를 설치합니다.

PS > pipx install pipenv

프로젝트 폴더 및 파이썬 개발 환경 구성

우선 윈도우 서비스 프로그램을 만들기 위한 프로젝트 폴더를 만듭니다. 이 글에서는 trac_service라는 이름을 사용합니다.

PS > New-Item -ItemType Directory -Path "$env:HOMEPATH\trac_service"

그리고 trac_service 폴더로 이동합니다. 그리고 pipenv를 사용해 파이썬 가상 환경을 생성하면서 윈도우 서비스 개발에 필요한 라이브러리를 설치합니다.

PS > cd "$env:HOMEPATH\trac_service"
PS > pipenv install pywin32
PS > pipenv install pyinstaller

이로서 파이썬 가상 환경 생성까지 마쳤습니다.

윈도우 서비스 기본 클래스 생성하기

파이썬으로 윈도우 서비스를 만드려면 pywin32가 제공하는 win32serviceutil, servicemanager, win32event, win32service 모듈이 필요합니다.

이들 모듈은 윈도우 운영체제 내부에 접근할 수 있는 기능을 제공합니다.

윈도우 서비스는 win32serviceutil 모듈의 ServiceFramework 클래스를 상속받으면 만들 수 있습니다. ABC 클래스는 SMWinservice 클래스를 직접 초기화하지 못하게 하기 위해서 상속받았습니다.

smservice.py

from abc import ABC, abstractmethod

import win32serviceutil
import servicemanager
import win32event
import win32service

class SMWinservice(win32serviceutil.ServiceFramework, ABC):
    pass

상속받는 클래스의 이름은 편의상 SMWinservice로 합니다. 이 클래스를 사용해 윈도우 서비스를 등록하려면 클래스 내부에 클래스 변수 3개를 선언해야 합니다.

smservice.py

from abc import ABC, abstractmethod

import win32serviceutil
import servicemanager
import win32event
import win32service

class SMWinservice(win32serviceutil.ServiceFramework, ABC):

    _svc_name_ = 'pythonService'
    _svc_display_name_ = 'Python Service'
    _svc_description_ = 'Python Service Description'

클래스 변수는 _svc_name_, _svc_display_name_, _svc_description_ 를 선언하며 _svc_name_은 띄워쓰기 없이 영어로 시작하는 이름을 입력해야 합니다. 이 이름이 윈도우에서 서비스을 식별하는 이름이 되기 때문입니다.

_svc_display_name_ 은 윈도우 서비스 관리자를 실행했을 때 관리자가 서비스를 식별하는 이름입니다. 관리자가 식별하는 이름이기 때문에 띄워쓰기가 있어도 상관없습니다. _svc_description_ 은 이 서비스가 어떤 일을 하는 서비스인지 자세하게 쓰시면 됩니다.

이 변수들은 SMWinservice 클래스를 상속하는 다른 클래스에서 덮어쓰기 할 것이므로 여기서는 간단히 입력해도 됩니다.

클래스 변수를 선언했으면 기본 클래스가 가져야 하는 7개 메서드를 선언합니다.

smservice.py

from abc import ABC, abstractmethod

import win32serviceutil
import servicemanager
import win32event
import win32service


class SMWinservice(win32serviceutil.ServiceFramework, ABC):
    '''Base class to create winservice in Python'''

    _svc_name_ = 'pythonService'
    _svc_display_name_ = 'Python Service'
    _svc_description_ = 'Python Service Description'

    def __init__(self, args):
        pass

    def SvcStop(self):
        pass

    def SvcDoRun(self):
        pass

    @classmethod
    def parse_command_line(cls):
        pass

    @abstractmethod
    def start(self):
        pass

    @abstractmethod
    def stop(self):
        pass

    @abstractmethod
    def main(self):
        pass

이들 7개 메서드 중 반드시 선언해야 하는 메서드는 __init__, SvcDoRun, SvcStop 메서드입니다. Svc* 메서드들은 윈도우 시스템에서 직접 호출하기 때문에 반드시 필요합니다.

나머지 메서드는 클래스를 쉽게 사용하고 확장할 수 있게 하는 메서드입니다.

이제 __init__, SvcStop, SvcDoRun 메서드의 내용을 채우겠습니다.

smservice.py

from abc import ABC, abstractmethod

import socket

import win32serviceutil
import servicemanager
import win32event
import win32service


class SMWinservice(win32serviceutil.ServiceFramework, ABC):
    _svc_name_ = 'pythonService'
    _svc_display_name_ = 'Python Service'
    _svc_description_ = 'Python Service Description'

    def __init__(self, args):
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)
        socket.setdefaulttimeout(60)

    def SvcStop(self):
        self.stop()
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
        win32event.SetEvent(self.hWaitStop)

    def SvcDoRun(self):
        self.start()
        servicemanager.LogMsg(servicemanager.EVENTLOG_INFORMATION_TYPE,
                            servicemanager.PYS_SERVICE_STARTED,
                            (self._svc_name_, ''))
        self.main()

    @classmethod
    def parse_command_line(cls):
        win32serviceutil.HandleCommandLine(cls)

    @abstractmethod
    def start(self):
        pass

    @abstractmethod
    def stop(self):
        pass

    @abstractmethod
    def main(self):
        pass

__init__ 메서드에서는 SMWinservice 클래스를 초기화합니다. __init__ 메서드는 args 인자를 반드시 받아야 합니다.

그리고 부모 클래스를 초기화하고 객체 내부에 윈도우 시스템이 다룰 “이벤트” 객체를 선언하고 반환값을 객체 내부의 hWaitStop 필드 변수에 저장합니다. 이벤트 객체의 선언은 win32event 모듈의 CreateEvent 함수를 호출해서 만듭니다.

그런 다음 파이썬의 socket 모듈을 들고 와서 기본 타임아웃 시간을 60초로 선언합니다. 타임아웃 지정은 setdefaulttimeout 함수를 사용하며 이 함수는 윈도우 서비스 프로그램이 60초 이내에 실행되지 않으면 문제가 발생했다는 사실을 알리는데 사용합니다.

다음으로 SvcDoRun 메서드를 설명하겠습니다. 이 메서드는 윈도우 서비스가 시작하면 호출되는 메서드입니다. 윈도우 서비스는 시작되면 메모리에서 무한 루프 상태로 동작해야 합니다. 이에 따라 이 메서드 안에서 무한 루프로 동작하는 프로그램의 실행 로직을 배치합니다.

여기에서는 SvcDoRun 메서드에 실제 실행 로직을 배치하지 않고 객체 메서드인 start와 main 메서드를 호출하도록 했습니다. 이렇게 실행되는 메서드를 분리하면 프로그램의 유지보수성이 높아지기에 권장되는 방식입니다.

SvcDoRun 메서드에서는 start와 main 메서드 호출 사이에 윈도우 이벤트 로그에 로그를 남기기 위해 servicemanager 모듈의 LogMsg 함수를 호출하고 있습니다.

다음과 같은 용법으로 사용합니다.

servicemanager.LogMsg([LogType], [EventId], ([Log Message], ''))

[LogType]과 [EventId]는 pywin32의 servicemanager에서 제공하는 상수를 사용합니다. SvcDoRun 메서드에서는 [LogType]으로 servicemanager.EVENTLOG_INFORMATION_TYPE를 사용하고 [EventId]로 servicemanager.PYS_SERVICE_STARTED를 사용했습니다.

그리고 [Log Message]는 로그 항목에 표시될 실제 로그 내용을 전달합니다.

SvcDoRun에서 호출하는 start와 main 메서드는 다음과 같은 일을 합니다.

start - 무한 루프로 동작하는 프로그램을 실행하기 전에 미리 해야 하는 일을 선언합니다.
main - 무한 루프로 동작하는 프로그램의 실행 로직을 여기에 넣습니다.

이제 SvcStop 메서드를 살펴보겠습니다. 이 메서드는 윈도우 서비스가 중지 요청되었을 때 실행되는 메서드입니다. 이 메서드는 호출되자마자 객체의 stop 메서드를 호출합니다. stop 메서드는 우리가 나중에 재정의하는 메서드로 우리가 실행한 무한 루프 프로그램을 중지시키는데 사용하는 메서드입니다.

그런 다음 윈도우에게 당신이 중지 요청한 서비스가 종료되기를 기다리고 있다고 알려야 합니다. 이를 위해 부모 클래스의 ReportServiceStatus 함수에 win32service 모듈의 SERVICE_STOP_PENDING 상수를 전달합니다.

win32event 모듈의 SetEvent 함수에게 __init__ 메서드에서 만들었던 이벤트 객체인 hWaitStop 필드 변수를 전달하는 것으로 SvcStop 메서드 구현이 완료됩니다.

마지막으로 parse_command_line 메서드를 구현합니다. 이 메서드는 우리가 만든 윈도우 서비스를 관리하기 위해 호출하는 메서드입니다. 이 메서드는 파이썬 클래스의 “클래스 메서드”로 선언되었기 때문에 메서드의 인자로 cls가 전달되었습니다. win32serviceutil의 HandleCommandLine 함수에 메서드의 인자로 받은 cls를 전달하기만 하면 됩니다.

이것으로 윈도우 서비스 기본 클래스 구현이 완료되었습니다.

지금까지 작성한 내용을 바탕으로 완성한 파일의 내용은 다음과 같습니다(완성된 코드에는 프로그램의 이해를 돕기 위한 주석이 많이 포함되어 있습니다).

smservice.py

import socket

import win32serviceutil
import servicemanager
import win32event
import win32service


class SMWinservice(win32serviceutil.ServiceFramework):
    '''Base class to create winservice in Python'''

    _svc_name_ = 'pythonService'
    _svc_display_name_ = 'Python Service'
    _svc_description_ = 'Python Service Description'

    @classmethod
    def parse_command_line(cls):
        '''
        ClassMethod to parse the command line
        '''
        win32serviceutil.HandleCommandLine(cls)

    def __init__(self, args):
        '''
        Constructor of the winservice
        '''
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)
        socket.setdefaulttimeout(60)

    def SvcStop(self):
        '''
        Called when the service is asked to stop
        '''
        self.stop()
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
        win32event.SetEvent(self.hWaitStop)

    def SvcDoRun(self):
        '''
        Called when the service is asked to start
        '''
        self.start()
        servicemanager.LogMsg(servicemanager.EVENTLOG_INFORMATION_TYPE,
                            servicemanager.PYS_SERVICE_STARTED,
                            (self._svc_name_, ''))
        self.main()

    def start(self):
        '''
        Override to add logic before the start
        eg. running condition
        '''
        pass

    def stop(self):
        '''
        Override to add logic before the stop
        eg. invalidating running condition
        '''
        pass

    def main(self):
        '''
        Main class to be ovverridden to add logic
        '''
        pass

커스텀 윈도우 서비스 클래스 만들기

윈도우 서비스의 기본 클래스를 생성했으면 다음으로 실제 우리가 등록할 서비스 클래스를 만듭니다. 우리가 만들 서비스 클래스는 앞에서 만든 SMWinservice 클래스를 상속받아 만듭니다.

여기에서 만드는 커스텀 윈도우 서비스 클래스는 Trac(https://trac.edgewall.org) 데몬을 실행하는 tracd 명령을 실행합니다.

그렇기 때문에 여기에서 재정의하는 하는 것은 클래스 변수 _svc_name_, _svc_display_name_, _svc_description_와 start, main, stop 메서드입니다. 예시로 명명한 파일 이름은 tracservice.py 입니다.

tracservice.py

from smservice import SMWinservice

class TracService(SMWinservice):
    _svc_name_ = "TracWinService"
    _svc_display_name_ = "Trac on Windows"
    _svc_description_ = "Trac Windows Service"

    def start(self):
        pass

    def stop(self):
        pass

    def main(self):
        pass

_svc_name_, _svc_display_name_, _svc_description_ 는 적절한 내용으로 입력하시면 되는데 여기서는 Trac을 띄울 것이므로 Trac에 관한 내용으로 채웠습니다.

여기에서 재정의 하는 main 메서드가 호출되면 프로그램이 무한 루프로 실행되어야 합니다. 예를 들면 다음과 같은 무한 루프 로직이 동작해야 합니다.

while True:
    # 여기에서 무한 루프 내에서 실행할 문장 기술
    pass

main 메서드 내부에 무한 루프로 동작하는 코드를 직접 추가해도 되지만 “윈도우 서비스”는 어디까지나 서비스 시작시 무한 루프로 실행되도록 프로그램은 별도의 실행 파일로 분리하는 것이 좋습니다.

별도의 실행 파일로 로직을 분리하지 않으면 나중에 프로그램이 업데이트 되었을 때 여러 어려움이 발생합니다.

윈도우 서비스를 다시 인스톨하거나 서비스 업데이트 필요
프로그램의 실제 로직 추가로 프로그램 용량이 매우 커지고 서비스 프로그램의 유지보수가 어려워짐

그리고 tracd 명령은 한 번 실행되면 메모리에서 무한 루프로 실행되기 때문에 여기에서는 main 메서드 내에 따로 while 문을 사용하지 않았습니다.

실제 코드를 구현하기에 앞서 Trac은 다음과 같이 설치되어 있다고 가정합니다. 이 글에서는 Trac의 설치 및 환경 구성은 살펴보지 않습니다.

Trac 패키지가 설치된 파이썬 가상 환경 경로 : %HOMEPATH%trac-venv
Trac 환경 : %HOMEPATH%tracreposproject

이렇게 설치되어 있는 trac 환경은 다음 명령으로 실행합니다.

PS > $env:HOMEPATH\trac-venv\tracd --port 8000 $env:HOMEPATH\trac\repos\project

이렇게 하면 8000번 포트로 trac 서버가 실행됩니다.

start 메서드부터 살펴보겠습니다.

def start(self):
    self.exec_process = None
    daemon_path = Path(sys.argv[0])

    self._env_path_ = daemon_path.parent / "config.json"

start 메서드에서는 main 메서드를 호출하기 전에 tracd 프로그램을 실행하기 위한 사전 작업을 준비합니다. tracd 명령은 파이썬 subprocess 모듈의 Popen 클래스를 사용해 실행합니다. Popen 클래스는 초기화되면 운영체제를 대신해 실행중인 프로세스를 제어할 수 있도록 Popen 객체를 반환합니다.

이에 따라 Popen 클래스를 초기화 하기 전에 Popen 객체를 담아놓을 필드 변수 exec_process를 start 메서드 안에서 선언합니다. 이렇게 만든 exec_process 필드 변수는 윈도우 서비스가 중지 요청되면 stop 메서드 안에서 사용됩니다.

start 메서드에서 하나 더 유심히 볼 부분은 _env_path_를 선언한 부분입니다.

사실 서비스 클래스를 윈도우 서비스로 등록하고 나면 서비스 클래스는 main 메서드 안에서 tracd 명령이 어떤 경로에 있는지, trac 환경이 어떤 경로에 있는지 알 수 없습니다.

그래서 tracd 명령이 있는 경로와 trac 환경을 파이썬 환경에 하드 코딩하는 방법이 사용되기도 합니다. 하지만 이 경우 나중에 시간이 지나고 나면 trac 패키지를 설치한 가상 환경이 어디에 있는지 Trac 환경이 어디에 있는지 알기 어렵습니다.

그렇기 때문에 여기에서는 파이썬 가상 환경이 설치된 경로와 tracd 명령을 config.json으로 담아놓고 start 메서드 실행시 config.json이 있는 경로를 절대 경로로 고정해뒀습니다.

config.json 파일의 경로는 커스텀 윈도우 서비스 파일(ex. tracservice.exe)이 있는 경로에 있다고 가정합니다.

설정 파일 만들기

config.json

{
    "exec_start": "tracd --port 8000 C:\\Users\\gildong\\trac\\repos\\project",
    "python_home": "C:\\Users\\gildong\\trac-venv"
}

config.json 파일에서는 exec_start 키와 python_home 키를 가지고 있으며 python_home은 파이썬 가상 환경의 경로, exec_start는 tracd 실행 명령을 적었습니다. 참고로 경로는 역슬래시()를 2개씩 사용해야 합니다.

이제 main 메서드를 살펴봅니다. main 메서드는 config.json 파일을 읽어들여 exec_start 키의 내용으로 프로그램을 실행합니다.

def main(self):
    if not self._env_path_.exists():
        raise ValueError(f'{self._env_path_} File Not Found')

    config_obj = json.load(open(self._env_path_))

    python_home = config_obj.get("python_home")
    exec_start = config_obj.get("exec_start")
    exec_command = f"{python_home}\\Scripts\\{exec_start}"

    exec_env = os.environ.copy()
    exec_env.update(config_obj.get("env", {}))

    self.exec_process = subprocess.Popen(
        shlex.split(exec_command, posix=False),
        stdout=subprocess.PIPE,
        stderr=subprocess.PIPE,
        env=exec_env)
    self.exec_process.wait()

main 메서드가 처음 실행되면 우선 config.json이 있는지 검사합니다. 만약 config.json을 찾을 수 없다면 ValueError 예외를 발생시키고 윈도우 서비스를 시작하지 않습니다. 커스텀 서비스 클래스가 실행할 정보를 확인할 수 없으니 당연한 수순입니다.

파일을 찾았으면 config_obj에 config.json을 읽어 파이썬 딕셔너리로 보관해둡니다.

그런 다음 config_obj에 저장해둔 python_home과 exec_start 키를 읽어들인 다음 최종적으로 실행할 tracd 실행 명령을 만들어둡니다. 여기에서는 tracd가 [python_home]Scripts에 있다고 생각하기 때문에 경로는 [python_home]Scripts[exec_start]가 됩니다.

혹시라도 tracd가 참고하는 윈도우 환경 변수가 필요할 수 있기 때문에 운영체제 환경 변수를 복사하고 config.json에 env 키(JSON Object)의 내용을 병합해서 exec_env에 담아둡니다.

실행할 경로도 다 만들어졌겠다 이제 Popen 클래스를 사용해 exec_command를 실행합니다. subprocess는 첫 번째 인자의 값은 특별한 일이 없으면 실행 명령에 있는 공백을 구분 문자로 해서 MutableSequence로 제공해야 합니다.

위에 있는 config.json을 예시로 든다면 Popen에 전달해야 하는 값은 ["C:\Users\gildong\trac-venv\Scripts\tracd", "--port", "8000", "C:\Users\gildong\trac\repos\project"] 형태로 전달해야 합니다. 그런데 이렇게 명령을 분할해주는건 아무래도 불편하기 때문에 shlex 모듈의 split 함수를 사용해서 하나의 긴 문자열을 MutableSequence로 변경해줄 수 있습니다.

단, 이 글에서는 윈도우을 실행 환경으로 두고 있기 때문에 shlex.split 함수를 실행할 때 posix 인자에 False를 따로 제공했습니다. 윈도우에서 Popen를 실행한다면 꼭 잊지 않으셔야 합니다. 나머지 인자에 대한 설명은 파이썬 공식 문서를 참조하세요.

main 메서드의 마지막입니다. 서두에서 언급한 것처럼 main 메서드는 무한 루프 상태로 시작해야 하는데 subprocess로 tracd를 실행해서 self.exec_process에 담아놓는다고 끝난게 아닙니다. Popen 클래스로 실행한 명령이 어떤식으로든 끝날 때까지 파이썬 프로그램이 기다리게 해야 합니다.

바로 이 때, Popen 객체의 wait 메서드를 호출합니다. wait 메서드는 Popen 클래스로 실행한 명령이 끝날 때까지 파이썬 프로그램을 끝내지 말고 대기하라는 메서드입니다.

결과적으로 main 메서드에서 우리가 무한 루프를 돌리지 않아도 wait 메서드가 대신 tracd가 내부적으로 실행하는 무한 루프가 끝날때까지 기다립니다.

마지막으로 stop 메서드를 구현합니다. stop 메서드는 SvcStop 메서드가 처음 호출하도록 되어 있는거 기억하시죠?

def stop(self):
    self.exec_process.terminate()

stop 메서드에서는 단순히 self.exec_process에 담아놓은 Popen 객체의 terminate 메서드를 호출하는 것 뿐입니다. terminate 메서드는 Popen이 잡고 있는 프로세스에게 종료 명령을 내리는 것입니다.

마지막으로 tracservice.py 파일의 끝에 다음 내용으로 커스텀 윈도우 서비스 클래스를 윈도우 서비스 관리자가 제어할 수 있도록 해줘야 합니다.

if __name__ == '__main__':
    parser = argparse.ArgumentParser(
                    prog=__file__,
                    description='Windows Service Register')
    parser.add_argument('mode', nargs='?')
    args = parser.parse_args()

    if args.mode:
        TracService.parse_command_line()
    else:
        servicemanager.Initialize()
        servicemanager.PrepareToHostSingle(TracService)
        servicemanager.StartServiceCtrlDispatcher()

argparse 명령의 첫 번째 실행 인자가 전달되면 앞에서 만든 parse_command_line 메서드를 호출하게 하고 윈도우 서비스 관리자가 직접 실행하게 하는거면 servicemanager 모듈의 몇 개 함수를 순차적으로 호출시켜줍니다.

완성된 tracservice.py 파일 구현이 끝나면 아래와 같아야 합니다(물론 완성된 코드엔 import 해야 하는 코드 및 로깅을 위한 코드나 주석이 일부 포함되어 있습니다).

tracservice.py

import argparse
import subprocess
import json
import os
import shlex
import sys
from pathlib import Path

from smservice import SMWinservice

import win32serviceutil
import servicemanager


class TracService(SMWinservice):
    _svc_name_ = "TracWinService"
    _svc_display_name_ = "Trac on Windows"
    _svc_description_ = "Trac Windows Service"

    def logging(self, type_, message):
        event_type = getattr(servicemanager, type_)

        servicemanager.LogMsg(event_type, 0x1000, (message, ''))

    def logging_info(self, message):
        self.logging('EVENTLOG_INFORMATION_TYPE', message)

    def logging_error(self, message):
        self.logging('EVENTLOG_ERROR_TYPE', message)

    def logging_audit(self, message):
        self.logging('EVENTLOG_AUDIT_SUCCESS', message)

    def start(self):
        self.exec_process = None
        daemon_path = Path(sys.argv[0])

        self._env_path_ = daemon_path.parent / "config.json"

    def stop(self):
        self.exec_process.terminate()

        self.logging_info(f"{self._svc_name_} Service Stopped")

    def main(self):
        if not self._env_path_.exists():
            self.logging_error(f"{self._svc_name_} Service Execution Failed")
            raise ValueError(f'{self._env_path_} File Not Found')

        config_obj = json.load(open(self._env_path_))

        python_home = config_obj.get("python_home")
        exec_start = config_obj.get("exec_start")
        exec_command = f"{python_home}\\Scripts\\{exec_start}"

        # self.logging_audit(exec_command)

        exec_env = os.environ.copy()
        exec_env.update(config_obj.get("env", {}))

        self.exec_process = subprocess.Popen(
            shlex.split(exec_command, posix=False),
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            env=exec_env)
        self.logging_audit(f"StdOut: {self.exec_process.stdout.read()}")
        self.logging_audit(f"StdErr: {self.exec_process.stderr.read()}")
        self.exec_process.wait()


if __name__ == '__main__':
    parser = argparse.ArgumentParser(
                    prog=__file__,
                    description='Windows Service Register')
    parser.add_argument('mode', nargs='?')
    args = parser.parse_args()

    if args.mode:
        TracService.parse_command_line()
    else:
        servicemanager.Initialize()
        servicemanager.PrepareToHostSingle(TracService)
        servicemanager.StartServiceCtrlDispatcher()

커스텀 서비스 클래스 구현까지 모두 끝났습니다. 이제 윈도우 서비스 관리자에 커스텀 서비스 클래스를 등록시킬 시간입니다.

윈도우 서비스 관리자에 커스텀 서비스 클래스를 등록하려면 반드시 exe 파일로 변환해야 합니다.

커스텀 서비스 클래스 파일을 exe로 만들기

커스텀 서비스 클래스 파일을 exe로 만들기 위한 사전 작업은 앞에서 다했기 때문에 여기에서 아래 명령을 내려 exe 파일을 만듭니다.

PS > pipenv run pyinstaller -F onefile --hidden-import win32timzone --uac-admin tracservice.py

이렇게 만들어진 파일은 명령을 실행한 디렉터리 아래의 dist 폴더에 만들어집니다. 앞에서 살펴본 config.json은 여기 dist 폴더에 넣어놓으면 됩니다.

단, dist 폴더의 내용은 시스템 관리자가 관리하는 폴더임을 나타낼 수 있는 곳에 옮겨놓는게 좋습니다.

윈도우 서비스 관리자 사용하기

윈도우 서비스 관리자에 등록하는 명령은 아래와 같습니다.

PS > tracservice.exe install

새로 업데이트된 윈도우 커스텀 서비스 클래스 파일(exe 파일)로 기존 윈도우 서비스 관리자의 내용을 변경하려면 다음 명령을 입력합니다.

PS > tracservice.exe update

더 이상 윈도우 커스텀 서비스를 사용하지 않는다면 다음 명령으로 윈도우 서비스 관리자에서 삭제합니다.

PS > tracservice.exe remove

윈도우 커스텀 서비스 클래스를 시작하려면 다음 명령을 입력합니다.

PS > tracservice.exe start

윈도우 커스텀 서비스 클래스를 중지하려면 다음 명령을 입력합니다.

PS > tracservice.exe stop

이 글에서 윈도우 커스텀 서비스를 파이썬으로 만드는 방법에 대해 살펴봤습니다. 당연히 어려우셨으리가 생각하지만 이런 것 하나하나가 여러분의 실력을 향상시키는데 도움이 되길 희망합니다.

from. 파이썬 수다장이 날다의 아저씨