[Python] 파이썬 코드를 실행 파일로 만들기 (PyInstaller)

파이썬 코드를 실행 파일로 만들기 (PyInstaller)

들어가며

• 파이썬 코드를 실행 파일(@.exe@)로 만들려면 PyInstaller 패키지를 사용하면 된다.
• PyInstaller를 사용하여 간단하게 파이썬 코드를 실행 파일로 만들어보는 방법을 알아보자.

 

방법

PyInstaller 설치하기

• 터미널에서 아래의 명령을 실행하여 PyInstaller를 설치한다.

> pip install pyinstaller

 

실행 파일(@.exe@) 만들기

• 파이썬 코드로 작성된 파일(@파이썬코드.py@)을 @pyinstaller@ 명령의 인자로 넣어준다.

> pyinstaller <파이썬코드.py>

 

• 예를 들어, @myApp.py@ 파일을 실행 파일(@.exe@)로 만들려면 아래와 같이 명령을 실행한다.

> pyinstaller myApp.py

 

• 실행 파일(@myApp.exe@)은 해당 @파이썬코드.py@ 파일이 위치하는 디렉터리 내의 @dist@ 폴더 내부의 @파이썬코드@ 폴더 내부에 생성된다.
  • @./dist/myApp/myApp.exe@

 

참고

기타 유용한 옵션들

콘솔 창이 출력되지 않도록 하기

• PyInstaller를 이용하여 만든 실행 파일을 실행할 경우, 기본적으로 콘솔 창이 함께 표시된다.
• 이 콘솔 창이 실행되지 않도록 하고 싶은 경우, 실행 파일을 만들 때 @-w@ 또는 @--windowed@ 옵션을 넣어준다.

> pyinstaller -w <파이썬코드.py>

> pyinstaller --windowed <파이썬코드.py>

 

실행 파일 하나만 생성하기

• PyInstaller를 이용하여 만든 실행 파일을 만들 경우, 생성된 @dist@ 폴더에는 실행 파일(@.exe@)과 함께 PyInstaller 명령을 실행한 파이썬 환경에 포함되어 있는 여러 모듈들이 함께 추가된다.
• 따라서 실행 파일(@.exe@) 하나만 생성하게 만들려면 실행 파일을 만들 때 @-F@ 또는 @--onefile@ 옵션을 넣어준다.
• 실행 파일은 해당 @파이썬코드.py@가 있는 디렉터리의 @dist@ 폴더 안에 생성된다.

> pyinstaller -F <파이썬코드.py>

> pyinstaller -onefile <파이썬코드.py>

 

실행 파일에 아이콘 넣기

• PyInstaller를 이용하여 만든 실행 파일을 만들 때, 실행 파일에 아이콘을 넣고 싶은 경우, 실행 파일을 만들 때 @--icon@ 옵션을 넣어준다.

> pyinstaller --icon=<아이콘.ico> <파이썬코드.py>

 

실행 파일 이름 지정하기

• PyInstaller를 이용하여 만든 실행 파일을 만들 때, 실행 파일에 이름을 넣고 싶은 경우, 실행 파일을 만들 때 @--n@ 옵션을 넣어준다.
• 이 옵션을 사용하지 않을 경우, 기본적으로 @파이썬코드.py@의 이름(@파이썬코드@)을 따라간다.

> pyinstaller -n <실행파일명> <파이썬코드.py>

 

디버그 모드로 실행 파일 만들기

• 모든 빌드가 제대로 되었는지 확인하기 위해 디버그 모드로 실행 파일을 만들려면 @-d@ 또는 @--debug@ 옵션을 넣어준다.

> pyinstaller -d <파이썬코드.py>

> pyinstaller --debug <파이썬코드.py>

 

@pyinstaller@ 명령의 여러 가지 옵션 정보 알아보기

• @pyinstaller@ 명령어 뒤에 @--help@ 옵션을 넣고 실행한다.

> pyinstaller --help

usage: pyinstaller [-h] [-v] [-D] [-F] [--specpath DIR] [-n NAME] [--add-data <SRC;DEST or SRC:DEST>]
                   [--add-binary <SRC;DEST or SRC:DEST>] [-p DIR] [--hidden-import MODULENAME]
                   [--collect-submodules MODULENAME] [--collect-data MODULENAME] [--collect-binaries MODULENAME]
                   [--collect-all MODULENAME] [--copy-metadata PACKAGENAME] [--recursive-copy-metadata PACKAGENAME]
                   [--additional-hooks-dir HOOKSPATH] [--runtime-hook RUNTIME_HOOKS] [--exclude-module EXCLUDES]
                   [--splash IMAGE_FILE] [-d {all,imports,bootloader,noarchive}] [--python-option PYTHON_OPTION] [-s]
                   [--noupx] [--upx-exclude FILE] [-c] [-w]
                   [-i <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">] [--disable-windowed-traceback]
                   [--version-file FILE] [-m <FILE or XML>] [--no-embed-manifest] [-r RESOURCE] [--uac-admin]
                   [--uac-uiaccess] [--win-private-assemblies] [--win-no-prefer-redirects] [--argv-emulation]
                   [--osx-bundle-identifier BUNDLE_IDENTIFIER] [--target-architecture ARCH]
                   [--codesign-identity IDENTITY] [--osx-entitlements-file FILENAME] [--runtime-tmpdir PATH]
                   [--bootloader-ignore-signals] [--distpath DIR] [--workpath WORKPATH] [-y] [--upx-dir UPX_DIR] [-a]
                   [--clean] [--log-level LEVEL]
                   scriptname [scriptname ...]

positional arguments:
  scriptname            Name of scriptfiles to be processed or exactly one .spec file. If a .spec file is specified,
                        most options are unnecessary and are ignored.

options:
  -h, --help            show this help message and exit
  -v, --version         Show program version info and exit.
  --distpath DIR        Where to put the bundled app (default: ./dist)
  --workpath WORKPATH   Where to put all the temporary work files, .log, .pyz and etc. (default: ./build)
  -y, --noconfirm       Replace output directory (default: SPECPATH\dist\SPECNAME) without asking for confirmation
  --upx-dir UPX_DIR     Path to UPX utility (default: search the execution path)
  -a, --ascii           Do not include unicode encoding support (default: included if available)
  --clean               Clean PyInstaller cache and remove temporary files before building.
  --log-level LEVEL     Amount of detail in build-time console messages. LEVEL may be one of TRACE, DEBUG, INFO, WARN,
                        DEPRECATION, ERROR, FATAL (default: INFO). Also settable via and overrides the PYI_LOG_LEVEL
                        environment variable.

What to generate:
  -D, --onedir          Create a one-folder bundle containing an executable (default)
  -F, --onefile         Create a one-file bundled executable.
  --specpath DIR        Folder to store the generated spec file (default: current directory)
  -n NAME, --name NAME  Name to assign to the bundled app and spec file (default: first script's basename)

What to bundle, where to search:
  --add-data <SRC;DEST or SRC:DEST>
                        Additional non-binary files or folders to be added to the executable. The path separator is
                        platform specific, ``os.pathsep`` (which is ``;`` on Windows and ``:`` on most unix systems)
                        is used. This option can be used multiple times.
  --add-binary <SRC;DEST or SRC:DEST>
                        Additional binary files to be added to the executable. See the ``--add-data`` option for more
                        details. This option can be used multiple times.
  -p DIR, --paths DIR   A path to search for imports (like using PYTHONPATH). Multiple paths are allowed, separated by
                        ``';'``, or use this option multiple times. Equivalent to supplying the ``pathex`` argument in
                        the spec file.
  --hidden-import MODULENAME, --hiddenimport MODULENAME
                        Name an import not visible in the code of the script(s). This option can be used multiple
                        times.
  --collect-submodules MODULENAME
                        Collect all submodules from the specified package or module. This option can be used multiple
                        times.
  --collect-data MODULENAME, --collect-datas MODULENAME
                        Collect all data from the specified package or module. This option can be used multiple times.
  --collect-binaries MODULENAME
                        Collect all binaries from the specified package or module. This option can be used multiple
                        times.
  --collect-all MODULENAME
                        Collect all submodules, data files, and binaries from the specified package or module. This
                        option can be used multiple times.
  --copy-metadata PACKAGENAME
                        Copy metadata for the specified package. This option can be used multiple times.
  --recursive-copy-metadata PACKAGENAME
                        Copy metadata for the specified package and all its dependencies. This option can be used
                        multiple times.
  --additional-hooks-dir HOOKSPATH
                        An additional path to search for hooks. This option can be used multiple times.
  --runtime-hook RUNTIME_HOOKS
                        Path to a custom runtime hook file. A runtime hook is code that is bundled with the executable
                        and is executed before any other code or module to set up special features of the runtime
                        environment. This option can be used multiple times.
  --exclude-module EXCLUDES
                        Optional module or package (the Python name, not the path name) that will be ignored (as
                        though it was not found). This option can be used multiple times.
  --splash IMAGE_FILE   (EXPERIMENTAL) Add an splash screen with the image IMAGE_FILE to the application. The splash
                        screen can display progress updates while unpacking.

How to generate:
  -d {all,imports,bootloader,noarchive}, --debug {all,imports,bootloader,noarchive}
                        Provide assistance with debugging a frozen
                        application. This argument may be provided multiple
                        times to select several of the following options.

                        - all: All three of the following options.

                        - imports: specify the -v option to the underlying
                          Python interpreter, causing it to print a message
                          each time a module is initialized, showing the
                          place (filename or built-in module) from which it
                          is loaded. See
                          https://docs.python.org/3/using/cmdline.html#id4.

                        - bootloader: tell the bootloader to issue progress
                          messages while initializing and starting the
                          bundled app. Used to diagnose problems with
                          missing imports.

                        - noarchive: instead of storing all frozen Python
                          source files as an archive inside the resulting
                          executable, store them as files in the resulting
                          output directory.

  --python-option PYTHON_OPTION
                        Specify a command-line option to pass to the Python interpreter at runtime. Currently supports
                        "v" (equivalent to "--debug imports"), "u", and "W <warning control>".
  -s, --strip           Apply a symbol-table strip to the executable and shared libs (not recommended for Windows)
  --noupx               Do not use UPX even if it is available (works differently between Windows and *nix)
  --upx-exclude FILE    Prevent a binary from being compressed when using upx. This is typically used if upx corrupts
                        certain binaries during compression. FILE is the filename of the binary without path. This
                        option can be used multiple times.

Windows and Mac OS X specific options:
  -c, --console, --nowindowed
                        Open a console window for standard i/o (default). On Windows this option has no effect if the
                        first script is a '.pyw' file.
  -w, --windowed, --noconsole
                        Windows and Mac OS X: do not provide a console window for standard i/o. On Mac OS this also
                        triggers building a Mac OS .app bundle. On Windows this option is automatically set if the
                        first script is a '.pyw' file. This option is ignored on *NIX systems.
  -i <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">, --icon <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">
                        FILE.ico: apply the icon to a Windows executable. FILE.exe,ID: extract the icon with ID from
                        an exe. FILE.icns: apply the icon to the .app bundle on Mac OS. If an image file is entered
                        that isn't in the platform format (ico on Windows, icns on Mac), PyInstaller tries to use
                        Pillow to translate the icon into the correct format (if Pillow is installed). Use "NONE" to
                        not apply any icon, thereby making the OS show some default (default: apply PyInstaller's
                        icon). This option can be used multiple times.
  --disable-windowed-traceback
                        Disable traceback dump of unhandled exception in windowed (noconsole) mode (Windows and macOS
                        only), and instead display a message that this feature is disabled.

Windows specific options:
  --version-file FILE   Add a version resource from FILE to the exe.
  -m <FILE or XML>, --manifest <FILE or XML>
                        Add manifest FILE or XML to the exe.
  --no-embed-manifest   Generate an external .exe.manifest file instead of embedding the manifest into the exe.
                        Applicable only to onedir mode; in onefile mode, the manifest is always embedded, regardless
                        of this option.
  -r RESOURCE, --resource RESOURCE
                        Add or update a resource to a Windows executable. The RESOURCE is one to four items,
                        FILE[,TYPE[,NAME[,LANGUAGE]]]. FILE can be a data file or an exe/dll. For data files, at least
                        TYPE and NAME must be specified. LANGUAGE defaults to 0 or may be specified as wildcard * to
                        update all resources of the given TYPE and NAME. For exe/dll files, all resources from FILE
                        will be added/updated to the final executable if TYPE, NAME and LANGUAGE are omitted or
                        specified as wildcard *. This option can be used multiple times.
  --uac-admin           Using this option creates a Manifest that will request elevation upon application start.
  --uac-uiaccess        Using this option allows an elevated application to work with Remote Desktop.

Windows Side-by-side Assembly searching options (advanced):
  --win-private-assemblies
                        Any Shared Assemblies bundled into the application will be changed into Private Assemblies.
                        This means the exact versions of these assemblies will always be used, and any newer versions
                        installed on user machines at the system level will be ignored.
  --win-no-prefer-redirects
                        While searching for Shared or Private Assemblies to bundle into the application, PyInstaller
                        will prefer not to follow policies that redirect to newer versions, and will try to bundle the
                        exact versions of the assembly.

Mac OS specific options:
  --argv-emulation      Enable argv emulation for macOS app bundles. If enabled, the initial open document/URL event
                        is processed by the bootloader and the passed file paths or URLs are appended to sys.argv.
  --osx-bundle-identifier BUNDLE_IDENTIFIER
                        Mac OS .app bundle identifier is used as the default unique program name for code signing
                        purposes. The usual form is a hierarchical name in reverse DNS notation. For example:
                        com.mycompany.department.appname (default: first script's basename)
  --target-architecture ARCH, --target-arch ARCH
                        Target architecture (macOS only; valid values: x86_64, arm64, universal2). Enables switching
                        between universal2 and single-arch version of frozen application (provided python installation
                        supports the target architecture). If not target architecture is not specified, the current
                        running architecture is targeted.
  --codesign-identity IDENTITY
                        Code signing identity (macOS only). Use the provided identity to sign collected binaries and
                        generated executable. If signing identity is not provided, ad-hoc signing is performed
                        instead.
  --osx-entitlements-file FILENAME
                        Entitlements file to use when code-signing the collected binaries (macOS only).

Rarely used special options:
  --runtime-tmpdir PATH
                        Where to extract libraries and support files in `onefile`-mode. If this option is given, the
                        bootloader will ignore any temp-folder location defined by the run-time OS. The
                        ``_MEIxxxxxx``-folder will be created here. Please use this option only if you know what you
                        are doing.
  --bootloader-ignore-signals
                        Tell the bootloader to ignore signals rather than forwarding them to the child process. Useful
                        in situations where for example a supervisor process signals both the bootloader and the child
                        (e.g., via a process group) to avoid signalling the child twice.

 

생성된 실행 파일의 용량이 정말 큰데 최적화 할 수는 없을까?

• PyInstaller는 실행 파일을 만들 때, PyInstaller 명령을 실행한 파이썬 환경에 있는 모든 모듈들을 포함시킨다. 즉, 파이썬 코드에서 @import@되어 있지 않는 모듈도 포함시킨다. 따라서 실행 파일의 용량이 정말 크다.
  • @exclude@ 옵션을 이용하여 불필요한 모듈들을 제외할 수도 있으나, 제외해야 할 모듈이 너무 많을 경우 무용지물이다.
• 따라서 파이썬에서 가상 환경을 만든 후 (가상 환경에 대한 자세한 내용은 이곳을 참고한다.)  PyInstaller를 이용하여 실행 파일을 만드는 것이 생성한 실행 파일의 용량을 최소로 줄일 수 있는 좋은 방법이다

 

PyInstaller 공식 문서

• PyInstaller에 대한 자세한 사용법은 아래의 공식 문서를 참고한다.

PyInstaller Manual — PyInstaller 5.13.0 documentation