#!/usr/bin/env python3
-# coding: utf-8
+
import os
import platform
import sys
-from PyInstaller.utils.hooks import collect_submodules
-
-OS_NAME = platform.system()
-if OS_NAME == 'Windows':
- from PyInstaller.utils.win32.versioninfo import (
- VarStruct, VarFileInfo, StringStruct, StringTable,
- StringFileInfo, FixedFileInfo, VSVersionInfo, SetVersion,
- )
-elif OS_NAME == 'Darwin':
- pass
-else:
- raise Exception('{OS_NAME} is not supported')
+from PyInstaller.__main__ import run as run_pyinstaller
-ARCH = platform.architecture()[0][:2]
+OS_NAME, ARCH = sys.platform, platform.architecture()[0][:2]
def main():
opts = parse_options()
- version = read_version()
+ version = read_version('yt_dlp/version.py')
- suffix = '_macos' if OS_NAME == 'Darwin' else '_x86' if ARCH == '32' else ''
- final_file = 'dist/%syt-dlp%s%s' % (
- 'yt-dlp/' if '--onedir' in opts else '', suffix, '.exe' if OS_NAME == 'Windows' else '')
+ onedir = '--onedir' in opts or '-D' in opts
+ if not onedir and '-F' not in opts and '--onefile' not in opts:
+ opts.append('--onefile')
+ name, final_file = exe(onedir)
print(f'Building yt-dlp v{version} {ARCH}bit for {OS_NAME} with options {opts}')
print('Remember to update the version using "devscripts/update-version.py"')
if not os.path.isfile('yt_dlp/extractor/lazy_extractors.py'):
print(f'Destination: {final_file}\n')
opts = [
- f'--name=yt-dlp{suffix}',
+ f'--name={name}',
'--icon=devscripts/logo.ico',
'--upx-exclude=vcruntime140.dll',
'--noconfirm',
+ # NB: Modules that are only imported dynamically must be added here.
+ # --collect-submodules may not work correctly if user has a yt-dlp installed via PIP
+ '--hidden-import=yt_dlp.compat._legacy',
*dependency_options(),
*opts,
'yt_dlp/__main__.py',
]
- print(f'Running PyInstaller with {opts}')
-
- import PyInstaller.__main__
-
- PyInstaller.__main__.run(opts)
+ print(f'Running PyInstaller with {opts}')
+ run_pyinstaller(opts)
set_version_info(final_file, version)
def parse_options():
- # Compatability with older arguments
+ # Compatibility with older arguments
opts = sys.argv[1:]
if opts[0:1] in (['32'], ['64']):
if ARCH != opts[0]:
raise Exception(f'{opts[0]}bit executable cannot be built on a {ARCH}bit system')
opts = opts[1:]
- return opts or ['--onefile']
+ return opts
+
+
+# Get the version from yt_dlp/version.py without importing the package
+def read_version(fname):
+ with open(fname, encoding='utf-8') as f:
+ exec(compile(f.read(), fname, 'exec'))
+ return locals()['__version__']
-def read_version():
- exec(compile(open('yt_dlp/version.py').read(), 'yt_dlp/version.py', 'exec'))
- return locals()['__version__']
+def exe(onedir):
+ """@returns (name, path)"""
+ name = '_'.join(filter(None, (
+ 'yt-dlp',
+ {'win32': '', 'darwin': 'macos'}.get(OS_NAME, OS_NAME),
+ ARCH == '32' and 'x86'
+ )))
+ return name, ''.join(filter(None, (
+ 'dist/',
+ onedir and f'{name}/',
+ name,
+ OS_NAME == 'win32' and '.exe'
+ )))
def version_to_list(version):
def dependency_options():
- dependencies = [pycryptodome_module(), 'mutagen', 'brotli', 'certifi'] + collect_submodules('websockets')
- excluded_modules = ['test', 'ytdlp_plugins', 'youtube-dl', 'youtube-dlc']
+ # Due to the current implementation, these are auto-detected, but explicitly add them just in case
+ dependencies = [pycryptodome_module(), 'mutagen', 'brotli', 'certifi', 'websockets']
+ excluded_modules = ['test', 'ytdlp_plugins', 'youtube_dl', 'youtube_dlc']
yield from (f'--hidden-import={module}' for module in dependencies)
+ yield '--collect-submodules=websockets'
yield from (f'--exclude-module={module}' for module in excluded_modules)
def set_version_info(exe, version):
- if OS_NAME == 'Windows':
+ if OS_NAME == 'win32':
windows_set_version(exe, version)
def windows_set_version(exe, version):
+ from PyInstaller.utils.win32.versioninfo import (
+ FixedFileInfo,
+ SetVersion,
+ StringFileInfo,
+ StringStruct,
+ StringTable,
+ VarFileInfo,
+ VarStruct,
+ VSVersionInfo,
+ )
+
version_list = version_to_list(version)
suffix = '_x86' if ARCH == '32' else ''
SetVersion(exe, VSVersionInfo(