8 from zipimport
import zipimporter
10 from .compat
import functools
# isort: split
11 from .compat
import compat_realpath
12 from .utils
import Popen
, shell_quote
, traverse_obj
, version_tuple
13 from .version
import __version__
15 REPOSITORY
= 'yt-dlp/yt-dlp'
16 API_URL
= f
'https://api.github.com/repos/{REPOSITORY}/releases/latest'
20 def _get_variant_and_executable_path():
21 """@returns (variant, executable_path)"""
22 if hasattr(sys
, 'frozen'):
24 if not hasattr(sys
, '_MEIPASS'):
26 if sys
._MEIPASS
== os
.path
.dirname(path
):
27 return f
'{sys.platform}_dir', path
28 return f
'{sys.platform}_exe', path
30 path
= os
.path
.dirname(__file__
)
31 if isinstance(__loader__
, zipimporter
):
32 return 'zip', os
.path
.join(path
, '..')
33 elif (os
.path
.basename(sys
.argv
[0]) in ('__main__.py', '-m')
34 and os
.path
.exists(os
.path
.join(path
, '../.git/HEAD'))):
36 return 'unknown', path
40 return _get_variant_and_executable_path()[0]
47 'darwin_exe': '_macos',
48 'linux_exe': '_linux',
51 _NON_UPDATEABLE_REASONS
= {
52 **{variant: None for variant in _FILE_SUFFIXES}
, # Updatable
53 **{variant: f'Auto-update is not supported for unpackaged {name} executable
; Re
-download the latest release
'
54 for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS', 'linux_dir': 'Linux'}.items()},
55 'source
': 'You cannot update when running
from source code
; Use git to pull the latest changes
',
56 'unknown
': 'It looks like you installed yt
-dlp
with a package manager
, pip
or setup
.py
; Use that to update
',
57 'other
': 'It looks like you are using an unofficial build of yt
-dlp
; Build the executable again
',
61 def is_non_updateable():
62 return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['other
'])
65 def _sha256_file(path):
67 mv = memoryview(bytearray(128 * 1024))
68 with open(os.path.realpath(path), 'rb
', buffering=0) as f:
69 for n in iter(lambda: f.readinto(mv), 0):
75 def __init__(self, ydl):
78 @functools.cached_property
79 def _new_version_info(self):
80 self.ydl.write_debug(f'Fetching release info
: {API_URL}
')
81 return json.loads(self.ydl.urlopen(API_URL).read().decode())
84 def current_version(self):
89 def new_version(self):
90 """Version of the latest release"""
91 return self._new_version_info['tag_name
']
95 """Whether there is an update available"""
96 return version_tuple(__version__) < version_tuple(self.new_version)
98 @functools.cached_property
100 """Filename of the executable"""
101 return compat_realpath(_get_variant_and_executable_path()[1])
103 def _download(self, name=None):
104 name = name or self.release_name
105 url = traverse_obj(self._new_version_info, (
106 'assets
', lambda _, v: v['name
'] == name, 'browser_download_url
'), get_all=False)
108 raise Exception('Unable to find download URL
')
109 self.ydl.write_debug(f'Downloading {name}
from {url}
')
110 return self.ydl.urlopen(url).read()
112 @functools.cached_property
113 def release_name(self):
114 """The release filename"""
115 label = _FILE_SUFFIXES[detect_variant()]
116 if label and platform.architecture()[0][:2] == '32':
117 label = f'_x86{label}
'
118 return f'yt
-dlp{label}
'
120 @functools.cached_property
121 def release_hash(self):
122 """Hash of the latest release"""
123 hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2
-256SUMS
').decode().splitlines())
124 return hash_data[self.release_name]
126 def _report_error(self, msg, expected=False):
127 self.ydl.report_error(msg, tb=False if expected else None)
129 def _report_permission_error(self, file):
130 self._report_error(f'Unable to write to {file}
; Try running
as administrator
', True)
132 def _report_network_error(self, action, delim=';'):
133 self._report_error(f'Unable to {action}{delim} Visit https
://github
.com
/{REPOSITORY}
/releases
/latest
', True)
135 def check_update(self):
136 """Report whether there is an update available"""
139 f'Latest version
: {self.new_version}
, Current version
: {self.current_version}
')
141 return self._report_network_error('obtain version info
', delim='; Please
try again later
or')
143 if not self.has_update:
144 return self.ydl.to_screen(f'yt
-dlp
is up to
date ({__version__}
)')
146 if not is_non_updateable():
147 self.ydl.to_screen(f'Current Build Hash {_sha256_file(self.filename)}
')
151 """Update yt-dlp executable to the latest version"""
152 if not self.check_update():
154 err = is_non_updateable()
156 return self._report_error(err, True)
157 self.ydl.to_screen(f'Updating to version {self.new_version}
...')
159 directory = os.path.dirname(self.filename)
160 if not os.access(self.filename, os.W_OK):
161 return self._report_permission_error(self.filename)
162 elif not os.access(directory, os.W_OK):
163 return self._report_permission_error(directory)
165 new_filename, old_filename = f'{self.filename}
.new
', f'{self.filename}
.old
'
166 if detect_variant() == 'zip': # Can be replaced in-place
167 new_filename, old_filename = self.filename, None
170 if os.path.exists(old_filename or ''):
171 os.remove(old_filename)
173 return self._report_error('Unable to remove the old version
')
176 newcontent = self._download()
178 return self._report_network_error('download latest version
')
180 return self._report_network_error('fetch updates
')
183 expected_hash = self.release_hash
185 self.ydl.report_warning('no
hash information found
for the release
')
187 if hashlib.sha256(newcontent).hexdigest() != expected_hash:
188 return self._report_network_error('verify the new executable
')
191 with open(new_filename, 'wb
') as outf:
192 outf.write(newcontent)
194 return self._report_permission_error(new_filename)
198 os.rename(self.filename, old_filename)
200 return self._report_error('Unable to move current version
')
203 os.rename(new_filename, self.filename)
205 self._report_error('Unable to overwrite current version
')
206 return os.rename(old_filename, self.filename)
208 if detect_variant() not in ('win32_exe
', 'py2exe
'):
210 os.remove(old_filename)
212 atexit.register(Popen, f'ping
127.0.0.1 -n
5 -w
1000 & del /F
"{old_filename}"',
213 shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
215 self.ydl.to_screen(f'Updated yt
-dlp to version {self.new_version}
')
218 @functools.cached_property
220 """The command-line to run the executable, if known"""
221 # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
222 if getattr(sys, 'orig_argv
', None):
224 elif hasattr(sys, 'frozen
'):
228 """Restart the executable"""
229 assert self.cmd, 'Must be frozen
or Py
>= 3.10'
230 self.ydl.write_debug(f'Restarting
: {shell_quote(self.cmd)}
')
231 _, _, returncode = Popen.run(self.cmd)
236 """Update the program file with the latest version from the repository
237 @returns Whether there was a successfull update (No update = False)
239 return Updater(ydl).update()
243 def update_self(to_screen, verbose, opener):
246 from .utils import write_string
249 'DeprecationWarning: "yt_dlp.update.update_self" is deprecated
and may be removed
in a future version
. '
250 'Use
"yt_dlp.update.run_update(ydl)" instead
\n')
257 def report_warning(self, msg, *args, **kwargs):
258 return printfn(f'WARNING
: {msg}
', *args, **kwargs)
260 def report_error(self, msg, tb=None):
261 printfn(f'ERROR
: {msg}
')
265 # Copied from YoutubeDL.trouble
266 if sys.exc_info()[0]:
268 if hasattr(sys.exc_info()[1], 'exc_info
') and sys.exc_info()[1].exc_info[0]:
269 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
270 tb += traceback.format_exc()
272 tb_data = traceback.format_list(traceback.extract_stack())
273 tb = ''.join(tb_data)
277 def write_debug(self, msg, *args, **kwargs):
278 printfn(f'[debug
] {msg}
', *args, **kwargs)
280 def urlopen(self, url):
281 return opener.open(url)
283 return run_update(FakeYDL())