11 from zipimport
import zipimporter
13 from .compat
import functools
# isort: split
14 from .compat
import compat_realpath
, compat_shlex_quote
26 from .version
import CHANNEL
, UPDATE_HINT
, VARIANT
, __version__
29 'stable': 'yt-dlp/yt-dlp',
30 'nightly': 'yt-dlp/yt-dlp-nightly-builds',
32 REPOSITORY
= UPDATE_SOURCES
['stable']
34 _VERSION_RE
= re
.compile(r
'(\d+\.)*\d+')
36 API_BASE_URL
= 'https://api.github.com/repos'
38 # Backwards compatibility variables for the current channel
39 API_URL
= f
'{API_BASE_URL}/{REPOSITORY}/releases'
43 def _get_variant_and_executable_path():
44 """@returns (variant, executable_path)"""
45 if getattr(sys
, 'frozen', False):
47 if not hasattr(sys
, '_MEIPASS'):
49 elif sys
._MEIPASS
== os
.path
.dirname(path
):
50 return f
'{sys.platform}_dir', path
51 elif sys
.platform
== 'darwin':
52 machine
= '_legacy' if version_tuple(platform
.mac_ver()[0]) < (10, 15) else ''
54 machine
= f
'_{platform.machine().lower()}'
55 # Ref: https://en.wikipedia.org/wiki/Uname#Examples
56 if machine
[1:] in ('x86', 'x86_64', 'amd64', 'i386', 'i686'):
57 machine
= '_x86' if platform
.architecture()[0][:2] == '32' else ''
58 return f
'{remove_end(sys.platform, "32")}{machine}_exe', path
60 path
= os
.path
.dirname(__file__
)
61 if isinstance(__loader__
, zipimporter
):
62 return 'zip', os
.path
.join(path
, '..')
63 elif (os
.path
.basename(sys
.argv
[0]) in ('__main__.py', '-m')
64 and os
.path
.exists(os
.path
.join(path
, '../.git/HEAD'))):
66 return 'unknown', path
70 return VARIANT
or _get_variant_and_executable_path()[0]
74 def current_git_head():
75 if detect_variant() != 'source':
77 with contextlib
.suppress(Exception):
78 stdout
, _
, _
= Popen
.run(
79 ['git', 'rev-parse', '--short', 'HEAD'],
80 text
=True, cwd
=os
.path
.dirname(os
.path
.abspath(__file__
)),
81 stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
)
82 if re
.fullmatch('[0-9a-f]+', stdout
.strip()):
90 'win_x86_exe': '_x86.exe',
91 'darwin_exe': '_macos',
92 'darwin_legacy_exe': '_macos_legacy',
93 'linux_exe': '_linux',
94 'linux_aarch64_exe': '_linux_aarch64',
95 'linux_armv7l_exe': '_linux_armv7l',
98 _NON_UPDATEABLE_REASONS
= {
99 **{variant: None for variant in _FILE_SUFFIXES}
, # Updatable
100 **{variant: f'Auto-update is not supported for unpackaged {name} executable
; Re
-download the latest release
'
101 for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS', 'linux_dir': 'Linux'}.items()},
102 'source
': 'You cannot update when running
from source code
; Use git to pull the latest changes
',
103 'unknown
': 'You installed yt
-dlp
with a package manager
or setup
.py
; Use that to update
',
104 'other
': 'You are using an unofficial build of yt
-dlp
; Build the executable again
',
108 def is_non_updateable():
111 return _NON_UPDATEABLE_REASONS.get(
112 detect_variant(), _NON_UPDATEABLE_REASONS['unknown
' if VARIANT else 'other
'])
115 def _sha256_file(path):
117 mv = memoryview(bytearray(128 * 1024))
118 with open(os.path.realpath(path), 'rb
', buffering=0) as f:
119 for n in iter(lambda: f.readinto(mv), 0):
127 def __init__(self, ydl, target=None):
130 self.target_channel, sep, self.target_tag = (target or CHANNEL).rpartition('@')
131 if not sep and self.target_tag in UPDATE_SOURCES: # stable => stable@latest
132 self.target_channel, self.target_tag = self.target_tag, None
133 elif not self.target_channel:
134 self.target_channel = CHANNEL
136 if not self.target_tag:
137 self.target_tag, self._exact = 'latest
', False
138 elif self.target_tag != 'latest
':
139 self.target_tag = f'tags
/{self.target_tag}
'
142 def _target_repo(self):
144 return UPDATE_SOURCES[self.target_channel]
146 return self._report_error(
147 f'Invalid update channel {self.target_channel!r} requested
. '
148 f'Valid channels are {", ".join(UPDATE_SOURCES)}
', True)
150 def _version_compare(self, a, b, channel=CHANNEL):
151 if channel != self.target_channel:
154 if _VERSION_RE.fullmatch(f'{a}
.{b}
'):
155 a, b = version_tuple(a), version_tuple(b)
156 return a == b if self._exact else a >= b
159 @functools.cached_property
161 if self._version_compare(self.current_version, self.latest_version):
162 return self.target_tag
164 identifier = f'{detect_variant()} {self.target_channel} {system_identifier()}
'
165 for line in self._download('_update_spec
', 'latest
').decode().splitlines():
166 if not line.startswith('lock
'):
168 _, tag, pattern = line.split(' ', 2)
169 if re.match(pattern, identifier):
172 elif self.target_tag == 'latest
' or not self._version_compare(
173 tag, self.target_tag[5:], channel=self.target_channel):
175 f'yt
-dlp cannot be updated above {tag} since you are on an older Python version
', True)
176 return f'tags
/{self.current_version}
'
177 return self.target_tag
180 def _get_version_info(self, tag):
181 url = f'{API_BASE_URL}
/{self._target_repo}
/releases
/{tag}
'
182 self.ydl.write_debug(f'Fetching release info
: {url}
')
183 return json.loads(self.ydl.urlopen(sanitized_Request(url, headers={
184 'Accept
': 'application
/vnd
.github
+json
',
185 'User
-Agent
': 'yt
-dlp
',
186 'X
-GitHub
-Api
-Version
': '2022-11-28',
190 def current_version(self):
191 """Current version"""
195 def _label(channel, tag):
196 """Label for a given channel and tag"""
197 return f'{channel}
@{remove_start(tag, "tags/")}
'
199 def _get_actual_tag(self, tag):
200 if tag.startswith('tags
/'):
202 return self._get_version_info(tag)['tag_name
']
205 def new_version(self):
206 """Version of the latest release we can update to"""
207 return self._get_actual_tag(self._tag)
210 def latest_version(self):
211 """Version of the target release"""
212 return self._get_actual_tag(self.target_tag)
215 def has_update(self):
216 """Whether there is an update available"""
217 return not self._version_compare(self.current_version, self.new_version)
219 @functools.cached_property
221 """Filename of the executable"""
222 return compat_realpath(_get_variant_and_executable_path()[1])
224 def _download(self, name, tag):
225 slug = 'latest
/download
' if tag == 'latest
' else f'download
/{tag[5:]}
'
226 url = f'https
://github
.com
/{self._target_repo}
/releases
/{slug}
/{name}
'
227 self.ydl.write_debug(f'Downloading {name}
from {url}
')
228 return self.ydl.urlopen(url).read()
230 @functools.cached_property
231 def release_name(self):
232 """The release filename"""
233 return f'yt
-dlp{_FILE_SUFFIXES[detect_variant()]}
'
235 @functools.cached_property
236 def release_hash(self):
237 """Hash of the latest release"""
238 hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2
-256SUMS
', self._tag).decode().splitlines())
239 return hash_data[self.release_name]
241 def _report_error(self, msg, expected=False):
242 self.ydl.report_error(msg, tb=False if expected else None)
243 self.ydl._download_retcode = 100
245 def _report_permission_error(self, file):
246 self._report_error(f'Unable to write to {file}
; Try running
as administrator
', True)
248 def _report_network_error(self, action, delim=';'):
250 f'Unable to {action}{delim} visit
'
251 f'https
://github
.com
/{self._target_repo}
/releases
/{self.target_tag.replace("tags/", "tag/")}
', True)
253 def check_update(self):
254 """Report whether there is an update available"""
255 if not self._target_repo:
259 f'Available version
: {self._label(self.target_channel, self.latest_version)}
, ' if self.target_tag == 'latest
' else ''
260 ) + f'Current version
: {self._label(CHANNEL, self.current_version)}
')
262 return self._report_network_error('obtain version info
', delim='; Please
try again later
or')
264 if not is_non_updateable():
265 self.ydl.to_screen(f'Current Build Hash
: {_sha256_file(self.filename)}
')
270 if self.target_tag == self._tag:
271 self.ydl.to_screen(f'yt
-dlp
is up to
date ({self._label(CHANNEL, self.current_version)}
)')
272 elif not self._exact:
273 self.ydl.report_warning('yt
-dlp cannot be updated any further since you are on an older Python version
')
277 """Update yt-dlp executable to the latest version"""
278 if not self.check_update():
280 err = is_non_updateable()
282 return self._report_error(err, True)
283 self.ydl.to_screen(f'Updating to {self._label(self.target_channel, self.new_version)}
...')
284 if (_VERSION_RE.fullmatch(self.target_tag[5:])
285 and version_tuple(self.target_tag[5:]) < (2023, 3, 2)):
286 self.ydl.report_warning('You are downgrading to a version without
--update
-to
')
288 directory = os.path.dirname(self.filename)
289 if not os.access(self.filename, os.W_OK):
290 return self._report_permission_error(self.filename)
291 elif not os.access(directory, os.W_OK):
292 return self._report_permission_error(directory)
294 new_filename, old_filename = f'{self.filename}
.new
', f'{self.filename}
.old
'
295 if detect_variant() == 'zip': # Can be replaced in-place
296 new_filename, old_filename = self.filename, None
299 if os.path.exists(old_filename or ''):
300 os.remove(old_filename)
302 return self._report_error('Unable to remove the old version
')
305 newcontent = self._download(self.release_name, self._tag)
306 except Exception as e:
307 if isinstance(e, urllib.error.HTTPError) and e.code == 404:
308 return self._report_error(
309 f'The requested tag {self._label(self.target_channel, self.target_tag)} does
not exist
', True)
310 return self._report_network_error(f'fetch updates
: {e}
')
313 expected_hash = self.release_hash
315 self.ydl.report_warning('no
hash information found
for the release
')
317 if hashlib.sha256(newcontent).hexdigest() != expected_hash:
318 return self._report_network_error('verify the new executable
')
321 with open(new_filename, 'wb
') as outf:
322 outf.write(newcontent)
324 return self._report_permission_error(new_filename)
327 mask = os.stat(self.filename).st_mode
329 os.rename(self.filename, old_filename)
331 return self._report_error('Unable to move current version
')
334 os.rename(new_filename, self.filename)
336 self._report_error('Unable to overwrite current version
')
337 return os.rename(old_filename, self.filename)
339 variant = detect_variant()
340 if variant.startswith('win
') or variant == 'py2exe
':
341 atexit.register(Popen, f'ping
127.0.0.1 -n
5 -w
1000 & del /F
"{old_filename}"',
342 shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
345 os.remove(old_filename)
347 self._report_error('Unable to remove the old version
')
350 os.chmod(self.filename, mask)
352 return self._report_error(
353 f'Unable to
set permissions
. Run
: sudo chmod a
+rx {compat_shlex_quote(self.filename)}
')
355 self.ydl.to_screen(f'Updated yt
-dlp to {self._label(self.target_channel, self.new_version)}
')
358 @functools.cached_property
360 """The command-line to run the executable, if known"""
361 # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
362 if getattr(sys, 'orig_argv
', None):
364 elif getattr(sys, 'frozen
', False):
368 """Restart the executable"""
369 assert self.cmd, 'Must be frozen
or Py
>= 3.10'
370 self.ydl.write_debug(f'Restarting
: {shell_quote(self.cmd)}
')
371 _, _, returncode = Popen.run(self.cmd)
376 """Update the program file with the latest version from the repository
377 @returns Whether there was a successful update (No update = False)
379 return Updater(ydl).update()
383 def update_self(to_screen, verbose, opener):
386 deprecation_warning(f'"{__name__}.update_self" is deprecated
and may be removed
'
387 f'in a future version
. Use
"{__name__}.run_update(ydl)" instead
')
394 def report_warning(self, msg, *args, **kwargs):
395 return printfn(f'WARNING
: {msg}
', *args, **kwargs)
397 def report_error(self, msg, tb=None):
398 printfn(f'ERROR
: {msg}
')
402 # Copied from YoutubeDL.trouble
403 if sys.exc_info()[0]:
405 if hasattr(sys.exc_info()[1], 'exc_info
') and sys.exc_info()[1].exc_info[0]:
406 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
407 tb += traceback.format_exc()
409 tb_data = traceback.format_list(traceback.extract_stack())
410 tb = ''.join(tb_data)
414 def write_debug(self, msg, *args, **kwargs):
415 printfn(f'[debug
] {msg}
', *args, **kwargs)
417 def urlopen(self, url):
418 return opener.open(url)
420 return run_update(FakeYDL())
423 __all__ = ['Updater
']