[Python]파이썬 스크립트를 exe 실행 파일로 빌드하기

파이썬으로 스크립트를 짜고 빌드한 산출물을 커맨드 라인에서 실행하는 방법도 있지만, 배포를 위해서는 exe 파일로 빌드해야 할 상황이 생긴다.

 

무엇보다 파이썬 설치가 불가능한 환경에서 파이썬 기반의 프로그램을 돌려야 할 상황이 생기면 난감하기 그지없다.

 

이럴 땐 PyInstaller 라는 툴을 이용해 쉽게 타파가 가능하다.

 

먼저 빌드할 환경에 PyInstaller 설치가 필요하다. pip을 이용해 쉽게 설치가 가능하다.

pip install pyinstaller

 

설치가 끝났으면 명령어를 이용해 변환해주기만 하면 된다. 스크립트가 있는 폴더로 이동하면 작업하기 편하다.

pyinstaller [파이썬 스크립트 경로]

 

상기 명령으로도 간단히 실행 파일 생성이 가능하지만, PyInstaller가 제공하는 옵션을 통해 좀 더 원하는 결과물에 근접할 수 있다.

 

더 다양한 옵션들이 있지만 실무에서 자주 사용했던 옵션을 정리했다.

옵션	설명
-F, --onefile	별도의 산출물 없이 하나의 exe 파일로 변환한다. 배포엔 용이하지만 실행 속도가 느려져 성능면에선 불리하다.
-n 이름, --name 이름	exe 파일의 이름을 설정한다. 옵션 생략 시, 스크립트의 이름을 따라간다.
--hidden-import 모듈명	파이썬 스크립트 내의 import와 동일한 기능이다. 사용하는 외부 라이브러리가 있을 시에 해당 옵션으로 추가해주면 된다.
--clean	이전 빌드 기록을 지우고 빌드한다. Visual Studio의 Clean Build 기능이라고 생각하면 이해하기 쉽다.

 

사용 시 참고 사항

1. PyInstaller는 기본적으로 현재 사용 중인 빌드 PC의 파이썬 환경을 따른다. 따라서 스크립트 상에 Import 된 라이브러리가 환경엔 설치되어 있지 않을 경우 에러가 난다. pip install 명령으로 Import 한 라이브러리를 모두 설치해주어야 한다.

 

2. 파이썬 환경 뿐만 아니라 OS도 탄다. 최종 배포 PC의 OS에 맞춰 빌드 PC의 OS도 맞춰주어야 한다.

(Window에서 사용 시 Window에서 빌드, Linux에서 사용 시 Linux에서 빌드)

 

3. --hidden-import 옵션으로 라이브러리를 참조할 때, 여타 커맨드 라인에서 실행되는 프로그램의 옵션과 달리 공백으로 구분하여 다수의 옵션 전달이 불가능하다. 따라서 참조하는 라이브러리가 여러 개라면, 하기와 같이 하나하나 옵션 처리를 해주어야 한다.

pyinstaller --hidden-import 모듈1 --hidden-import 모듈2 --hidden-import 모듈3 Test.py