10 from zipimport
import zipimporter
12 from .compat
import functools
# isort: split
13 from .compat
import compat_realpath
, compat_shlex_quote
22 from .version
import UPDATE_HINT
, VARIANT
, __version__
24 REPOSITORY
= 'yt-dlp/yt-dlp'
25 API_URL
= f
'https://api.github.com/repos/{REPOSITORY}/releases'
29 def _get_variant_and_executable_path():
30 """@returns (variant, executable_path)"""
31 if hasattr(sys
, 'frozen'):
33 if not hasattr(sys
, '_MEIPASS'):
35 if sys
._MEIPASS
== os
.path
.dirname(path
):
36 return f
'{sys.platform}_dir', path
37 if sys
.platform
== 'darwin' and version_tuple(platform
.mac_ver()[0]) < (10, 15):
38 return 'darwin_legacy_exe', path
39 return f
'{sys.platform}_exe', path
41 path
= os
.path
.dirname(__file__
)
42 if isinstance(__loader__
, zipimporter
):
43 return 'zip', os
.path
.join(path
, '..')
44 elif (os
.path
.basename(sys
.argv
[0]) in ('__main__.py', '-m')
45 and os
.path
.exists(os
.path
.join(path
, '../.git/HEAD'))):
47 return 'unknown', path
51 return VARIANT
or _get_variant_and_executable_path()[0]
55 def current_git_head():
56 if detect_variant() != 'source':
58 with contextlib
.suppress(Exception):
59 stdout
, _
, _
= Popen
.run(
60 ['git', 'rev-parse', '--short', 'HEAD'],
61 text
=True, cwd
=os
.path
.dirname(os
.path
.abspath(__file__
)),
62 stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
)
63 if re
.fullmatch('[0-9a-f]+', stdout
.strip()):
71 'darwin_exe': '_macos',
72 'darwin_legacy_exe': '_macos_legacy',
73 'linux_exe': '_linux',
76 _NON_UPDATEABLE_REASONS
= {
77 **{variant: None for variant in _FILE_SUFFIXES}
, # Updatable
78 **{variant: f'Auto-update is not supported for unpackaged {name} executable
; Re
-download the latest release
'
79 for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS', 'linux_dir': 'Linux'}.items()},
80 'source
': 'You cannot update when running
from source code
; Use git to pull the latest changes
',
81 'unknown
': 'You installed yt
-dlp
with a package manager
or setup
.py
; Use that to update
',
82 'other
': 'You are using an unofficial build of yt
-dlp
; Build the executable again
',
86 def is_non_updateable():
89 return _NON_UPDATEABLE_REASONS.get(
90 detect_variant(), _NON_UPDATEABLE_REASONS['unknown
' if VARIANT else 'other
'])
93 def _sha256_file(path):
95 mv = memoryview(bytearray(128 * 1024))
96 with open(os.path.realpath(path), 'rb
', buffering=0) as f:
97 for n in iter(lambda: f.readinto(mv), 0):
103 def __init__(self, ydl):
106 @functools.cached_property
108 if version_tuple(__version__) >= version_tuple(self.latest_version):
111 identifier = f'{detect_variant()} {system_identifier()}
'
112 for line in self._download('_update_spec
', 'latest
').decode().splitlines():
113 if not line.startswith('lock
'):
115 _, tag, pattern = line.split(' ', 2)
116 if re.match(pattern, identifier):
121 def _get_version_info(self, tag):
122 self.ydl.write_debug(f'Fetching release info
: {API_URL}
/{tag}
')
123 return json.loads(self.ydl.urlopen(f'{API_URL}
/{tag}
').read().decode())
126 def current_version(self):
127 """Current version"""
131 def new_version(self):
132 """Version of the latest release we can update to"""
133 if self._tag.startswith('tags
/'):
135 return self._get_version_info(self._tag)['tag_name
']
138 def latest_version(self):
139 """Version of the latest release"""
140 return self._get_version_info('latest
')['tag_name
']
143 def has_update(self):
144 """Whether there is an update available"""
145 return version_tuple(__version__) < version_tuple(self.new_version)
147 @functools.cached_property
149 """Filename of the executable"""
150 return compat_realpath(_get_variant_and_executable_path()[1])
152 def _download(self, name, tag):
153 url = traverse_obj(self._get_version_info(tag), (
154 'assets
', lambda _, v: v['name
'] == name, 'browser_download_url
'), get_all=False)
156 raise Exception('Unable to find download URL
')
157 self.ydl.write_debug(f'Downloading {name}
from {url}
')
158 return self.ydl.urlopen(url).read()
160 @functools.cached_property
161 def release_name(self):
162 """The release filename"""
163 label = _FILE_SUFFIXES[detect_variant()]
164 if label and platform.architecture()[0][:2] == '32':
165 label = f'_x86{label}
'
166 return f'yt
-dlp{label}
'
168 @functools.cached_property
169 def release_hash(self):
170 """Hash of the latest release"""
171 hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2
-256SUMS
', self._tag).decode().splitlines())
172 return hash_data[self.release_name]
174 def _report_error(self, msg, expected=False):
175 self.ydl.report_error(msg, tb=False if expected else None)
177 def _report_permission_error(self, file):
178 self._report_error(f'Unable to write to {file}
; Try running
as administrator
', True)
180 def _report_network_error(self, action, delim=';'):
181 self._report_error(f'Unable to {action}{delim} Visit https
://github
.com
/{REPOSITORY}
/releases
/latest
', True)
183 def check_update(self):
184 """Report whether there is an update available"""
187 f'Latest version
: {self.latest_version}
, Current version
: {self.current_version}
')
188 if not self.has_update:
189 if self._tag == 'latest
':
190 return self.ydl.to_screen(f'yt
-dlp
is up to
date ({__version__}
)')
191 return self.ydl.report_warning(
192 'yt
-dlp cannot be updated any further since you are on an older Python version
')
194 return self._report_network_error('obtain version info
', delim='; Please
try again later
or')
196 if not is_non_updateable():
197 self.ydl.to_screen(f'Current Build Hash {_sha256_file(self.filename)}
')
201 """Update yt-dlp executable to the latest version"""
202 if not self.check_update():
204 err = is_non_updateable()
206 return self._report_error(err, True)
207 self.ydl.to_screen(f'Updating to version {self.new_version}
...')
209 directory = os.path.dirname(self.filename)
210 if not os.access(self.filename, os.W_OK):
211 return self._report_permission_error(self.filename)
212 elif not os.access(directory, os.W_OK):
213 return self._report_permission_error(directory)
215 new_filename, old_filename = f'{self.filename}
.new
', f'{self.filename}
.old
'
216 if detect_variant() == 'zip': # Can be replaced in-place
217 new_filename, old_filename = self.filename, None
220 if os.path.exists(old_filename or ''):
221 os.remove(old_filename)
223 return self._report_error('Unable to remove the old version
')
226 newcontent = self._download(self.release_name, self._tag)
228 return self._report_network_error('download latest version
')
230 return self._report_network_error('fetch updates
')
233 expected_hash = self.release_hash
235 self.ydl.report_warning('no
hash information found
for the release
')
237 if hashlib.sha256(newcontent).hexdigest() != expected_hash:
238 return self._report_network_error('verify the new executable
')
241 with open(new_filename, 'wb
') as outf:
242 outf.write(newcontent)
244 return self._report_permission_error(new_filename)
247 mask = os.stat(self.filename).st_mode
249 os.rename(self.filename, old_filename)
251 return self._report_error('Unable to move current version
')
254 os.rename(new_filename, self.filename)
256 self._report_error('Unable to overwrite current version
')
257 return os.rename(old_filename, self.filename)
259 if detect_variant() in ('win32_exe
', 'py2exe
'):
260 atexit.register(Popen, f'ping
127.0.0.1 -n
5 -w
1000 & del /F
"{old_filename}"',
261 shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
264 os.remove(old_filename)
266 self._report_error('Unable to remove the old version
')
269 os.chmod(self.filename, mask)
271 return self._report_error(
272 f'Unable to
set permissions
. Run
: sudo chmod a
+rx {compat_shlex_quote(self.filename)}
')
274 self.ydl.to_screen(f'Updated yt
-dlp to version {self.new_version}
')
277 @functools.cached_property
279 """The command-line to run the executable, if known"""
280 # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
281 if getattr(sys, 'orig_argv
', None):
283 elif hasattr(sys, 'frozen
'):
287 """Restart the executable"""
288 assert self.cmd, 'Must be frozen
or Py
>= 3.10'
289 self.ydl.write_debug(f'Restarting
: {shell_quote(self.cmd)}
')
290 _, _, returncode = Popen.run(self.cmd)
295 """Update the program file with the latest version from the repository
296 @returns Whether there was a successful update (No update = False)
298 return Updater(ydl).update()
302 def update_self(to_screen, verbose, opener):
305 from .utils import write_string
308 'DeprecationWarning: "yt_dlp.update.update_self" is deprecated
and may be removed
in a future version
. '
309 'Use
"yt_dlp.update.run_update(ydl)" instead
\n')
316 def report_warning(self, msg, *args, **kwargs):
317 return printfn(f'WARNING
: {msg}
', *args, **kwargs)
319 def report_error(self, msg, tb=None):
320 printfn(f'ERROR
: {msg}
')
324 # Copied from YoutubeDL.trouble
325 if sys.exc_info()[0]:
327 if hasattr(sys.exc_info()[1], 'exc_info
') and sys.exc_info()[1].exc_info[0]:
328 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
329 tb += traceback.format_exc()
331 tb_data = traceback.format_list(traceback.extract_stack())
332 tb = ''.join(tb_data)
336 def write_debug(self, msg, *args, **kwargs):
337 printfn(f'[debug
] {msg}
', *args, **kwargs)
339 def urlopen(self, url):
340 return opener.open(url)
342 return run_update(FakeYDL())