10 from zipimport
import zipimporter
12 from .compat
import functools
# isort: split
13 from .compat
import compat_realpath
, compat_shlex_quote
23 from .version
import UPDATE_HINT
, VARIANT
, __version__
25 REPOSITORY
= 'yt-dlp/yt-dlp'
26 API_URL
= f
'https://api.github.com/repos/{REPOSITORY}/releases'
30 def _get_variant_and_executable_path():
31 """@returns (variant, executable_path)"""
32 if hasattr(sys
, 'frozen'):
34 if not hasattr(sys
, '_MEIPASS'):
36 if sys
._MEIPASS
== os
.path
.dirname(path
):
37 return f
'{sys.platform}_dir', path
38 if sys
.platform
== 'darwin' and version_tuple(platform
.mac_ver()[0]) < (10, 15):
39 return 'darwin_legacy_exe', path
40 return f
'{sys.platform}_exe', path
42 path
= os
.path
.dirname(__file__
)
43 if isinstance(__loader__
, zipimporter
):
44 return 'zip', os
.path
.join(path
, '..')
45 elif (os
.path
.basename(sys
.argv
[0]) in ('__main__.py', '-m')
46 and os
.path
.exists(os
.path
.join(path
, '../.git/HEAD'))):
48 return 'unknown', path
52 return VARIANT
or _get_variant_and_executable_path()[0]
56 def current_git_head():
57 if detect_variant() != 'source':
59 with contextlib
.suppress(Exception):
60 stdout
, _
, _
= Popen
.run(
61 ['git', 'rev-parse', '--short', 'HEAD'],
62 text
=True, cwd
=os
.path
.dirname(os
.path
.abspath(__file__
)),
63 stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
)
64 if re
.fullmatch('[0-9a-f]+', stdout
.strip()):
72 'darwin_exe': '_macos',
73 'darwin_legacy_exe': '_macos_legacy',
74 'linux_exe': '_linux',
77 _NON_UPDATEABLE_REASONS
= {
78 **{variant: None for variant in _FILE_SUFFIXES}
, # Updatable
79 **{variant: f'Auto-update is not supported for unpackaged {name} executable
; Re
-download the latest release
'
80 for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS', 'linux_dir': 'Linux'}.items()},
81 'source
': 'You cannot update when running
from source code
; Use git to pull the latest changes
',
82 'unknown
': 'You installed yt
-dlp
with a package manager
or setup
.py
; Use that to update
',
83 'other
': 'You are using an unofficial build of yt
-dlp
; Build the executable again
',
87 def is_non_updateable():
90 return _NON_UPDATEABLE_REASONS.get(
91 detect_variant(), _NON_UPDATEABLE_REASONS['unknown
' if VARIANT else 'other
'])
94 def _sha256_file(path):
96 mv = memoryview(bytearray(128 * 1024))
97 with open(os.path.realpath(path), 'rb
', buffering=0) as f:
98 for n in iter(lambda: f.readinto(mv), 0):
104 def __init__(self, ydl):
107 @functools.cached_property
109 if version_tuple(__version__) >= version_tuple(self.latest_version):
112 identifier = f'{detect_variant()} {system_identifier()}
'
113 for line in self._download('_update_spec
', 'latest
').decode().splitlines():
114 if not line.startswith('lock
'):
116 _, tag, pattern = line.split(' ', 2)
117 if re.match(pattern, identifier):
122 def _get_version_info(self, tag):
123 self.ydl.write_debug(f'Fetching release info
: {API_URL}
/{tag}
')
124 return json.loads(self.ydl.urlopen(f'{API_URL}
/{tag}
').read().decode())
127 def current_version(self):
128 """Current version"""
132 def new_version(self):
133 """Version of the latest release we can update to"""
134 if self._tag.startswith('tags
/'):
136 return self._get_version_info(self._tag)['tag_name
']
139 def latest_version(self):
140 """Version of the latest release"""
141 return self._get_version_info('latest
')['tag_name
']
144 def has_update(self):
145 """Whether there is an update available"""
146 return version_tuple(__version__) < version_tuple(self.new_version)
148 @functools.cached_property
150 """Filename of the executable"""
151 return compat_realpath(_get_variant_and_executable_path()[1])
153 def _download(self, name, tag):
154 url = traverse_obj(self._get_version_info(tag), (
155 'assets
', lambda _, v: v['name
'] == name, 'browser_download_url
'), get_all=False)
157 raise Exception('Unable to find download URL
')
158 self.ydl.write_debug(f'Downloading {name}
from {url}
')
159 return self.ydl.urlopen(url).read()
161 @functools.cached_property
162 def release_name(self):
163 """The release filename"""
164 label = _FILE_SUFFIXES[detect_variant()]
165 if label and platform.architecture()[0][:2] == '32':
166 label = f'_x86{label}
'
167 return f'yt
-dlp{label}
'
169 @functools.cached_property
170 def release_hash(self):
171 """Hash of the latest release"""
172 hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2
-256SUMS
', self._tag).decode().splitlines())
173 return hash_data[self.release_name]
175 def _report_error(self, msg, expected=False):
176 self.ydl.report_error(msg, tb=False if expected else None)
178 def _report_permission_error(self, file):
179 self._report_error(f'Unable to write to {file}
; Try running
as administrator
', True)
181 def _report_network_error(self, action, delim=';'):
182 self._report_error(f'Unable to {action}{delim} Visit https
://github
.com
/{REPOSITORY}
/releases
/latest
', True)
184 def check_update(self):
185 """Report whether there is an update available"""
188 f'Latest version
: {self.latest_version}
, Current version
: {self.current_version}
')
189 if not self.has_update:
190 if self._tag == 'latest
':
191 return self.ydl.to_screen(f'yt
-dlp
is up to
date ({__version__}
)')
192 return self.ydl.report_warning(
193 'yt
-dlp cannot be updated any further since you are on an older Python version
')
195 return self._report_network_error('obtain version info
', delim='; Please
try again later
or')
197 if not is_non_updateable():
198 self.ydl.to_screen(f'Current Build Hash {_sha256_file(self.filename)}
')
202 """Update yt-dlp executable to the latest version"""
203 if not self.check_update():
205 err = is_non_updateable()
207 return self._report_error(err, True)
208 self.ydl.to_screen(f'Updating to version {self.new_version}
...')
210 directory = os.path.dirname(self.filename)
211 if not os.access(self.filename, os.W_OK):
212 return self._report_permission_error(self.filename)
213 elif not os.access(directory, os.W_OK):
214 return self._report_permission_error(directory)
216 new_filename, old_filename = f'{self.filename}
.new
', f'{self.filename}
.old
'
217 if detect_variant() == 'zip': # Can be replaced in-place
218 new_filename, old_filename = self.filename, None
221 if os.path.exists(old_filename or ''):
222 os.remove(old_filename)
224 return self._report_error('Unable to remove the old version
')
227 newcontent = self._download(self.release_name, self._tag)
229 return self._report_network_error('download latest version
')
231 return self._report_network_error('fetch updates
')
234 expected_hash = self.release_hash
236 self.ydl.report_warning('no
hash information found
for the release
')
238 if hashlib.sha256(newcontent).hexdigest() != expected_hash:
239 return self._report_network_error('verify the new executable
')
242 with open(new_filename, 'wb
') as outf:
243 outf.write(newcontent)
245 return self._report_permission_error(new_filename)
248 mask = os.stat(self.filename).st_mode
250 os.rename(self.filename, old_filename)
252 return self._report_error('Unable to move current version
')
255 os.rename(new_filename, self.filename)
257 self._report_error('Unable to overwrite current version
')
258 return os.rename(old_filename, self.filename)
260 if detect_variant() in ('win32_exe
', 'py2exe
'):
261 atexit.register(Popen, f'ping
127.0.0.1 -n
5 -w
1000 & del /F
"{old_filename}"',
262 shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
265 os.remove(old_filename)
267 self._report_error('Unable to remove the old version
')
270 os.chmod(self.filename, mask)
272 return self._report_error(
273 f'Unable to
set permissions
. Run
: sudo chmod a
+rx {compat_shlex_quote(self.filename)}
')
275 self.ydl.to_screen(f'Updated yt
-dlp to version {self.new_version}
')
278 @functools.cached_property
280 """The command-line to run the executable, if known"""
281 # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
282 if getattr(sys, 'orig_argv
', None):
284 elif hasattr(sys, 'frozen
'):
288 """Restart the executable"""
289 assert self.cmd, 'Must be frozen
or Py
>= 3.10'
290 self.ydl.write_debug(f'Restarting
: {shell_quote(self.cmd)}
')
291 _, _, returncode = Popen.run(self.cmd)
296 """Update the program file with the latest version from the repository
297 @returns Whether there was a successful update (No update = False)
299 return Updater(ydl).update()
303 def update_self(to_screen, verbose, opener):
306 deprecation_warning(f'"{__name__}.update_self" is deprecated
and may be removed
'
307 f'in a future version
. Use
"{__name__}.run_update(ydl)" instead
')
314 def report_warning(self, msg, *args, **kwargs):
315 return printfn(f'WARNING
: {msg}
', *args, **kwargs)
317 def report_error(self, msg, tb=None):
318 printfn(f'ERROR
: {msg}
')
322 # Copied from YoutubeDL.trouble
323 if sys.exc_info()[0]:
325 if hasattr(sys.exc_info()[1], 'exc_info
') and sys.exc_info()[1].exc_info[0]:
326 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
327 tb += traceback.format_exc()
329 tb_data = traceback.format_list(traceback.extract_stack())
330 tb = ''.join(tb_data)
334 def write_debug(self, msg, *args, **kwargs):
335 printfn(f'[debug
] {msg}
', *args, **kwargs)
337 def urlopen(self, url):
338 return opener.open(url)
340 return run_update(FakeYDL())