9 from zipimport
import zipimporter
11 from .compat
import functools
# isort: split
12 from .compat
import compat_realpath
, compat_shlex_quote
21 from .version
import UPDATE_HINT
, VARIANT
, __version__
23 REPOSITORY
= 'yt-dlp/yt-dlp'
24 API_URL
= f
'https://api.github.com/repos/{REPOSITORY}/releases'
28 def _get_variant_and_executable_path():
29 """@returns (variant, executable_path)"""
30 if hasattr(sys
, 'frozen'):
32 if not hasattr(sys
, '_MEIPASS'):
34 if sys
._MEIPASS
== os
.path
.dirname(path
):
35 return f
'{sys.platform}_dir', path
36 if sys
.platform
== 'darwin' and version_tuple(platform
.mac_ver()[0]) < (10, 15):
37 return 'darwin_legacy_exe', path
38 return f
'{sys.platform}_exe', path
40 path
= os
.path
.dirname(__file__
)
41 if isinstance(__loader__
, zipimporter
):
42 return 'zip', os
.path
.join(path
, '..')
43 elif (os
.path
.basename(sys
.argv
[0]) in ('__main__.py', '-m')
44 and os
.path
.exists(os
.path
.join(path
, '../.git/HEAD'))):
46 return 'unknown', path
50 return VARIANT
or _get_variant_and_executable_path()[0]
57 'darwin_exe': '_macos',
58 'darwin_legacy_exe': '_macos_legacy',
59 'linux_exe': '_linux',
62 _NON_UPDATEABLE_REASONS
= {
63 **{variant: None for variant in _FILE_SUFFIXES}
, # Updatable
64 **{variant: f'Auto-update is not supported for unpackaged {name} executable
; Re
-download the latest release
'
65 for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS', 'linux_dir': 'Linux'}.items()},
66 'source
': 'You cannot update when running
from source code
; Use git to pull the latest changes
',
67 'unknown
': 'You installed yt
-dlp
with a package manager
or setup
.py
; Use that to update
',
68 'other
': 'You are using an unofficial build of yt
-dlp
; Build the executable again
',
72 def is_non_updateable():
75 return _NON_UPDATEABLE_REASONS.get(
76 detect_variant(), _NON_UPDATEABLE_REASONS['unknown
' if VARIANT else 'other
'])
79 def _sha256_file(path):
81 mv = memoryview(bytearray(128 * 1024))
82 with open(os.path.realpath(path), 'rb
', buffering=0) as f:
83 for n in iter(lambda: f.readinto(mv), 0):
89 def __init__(self, ydl):
92 @functools.cached_property
94 if version_tuple(__version__) >= version_tuple(self.latest_version):
97 identifier = f'{detect_variant()} {system_identifier()}
'
98 for line in self._download('_update_spec
', 'latest
').decode().splitlines():
99 if not line.startswith('lock
'):
101 _, tag, pattern = line.split(' ', 2)
102 if re.match(pattern, identifier):
107 def _get_version_info(self, tag):
108 self.ydl.write_debug(f'Fetching release info
: {API_URL}
/{tag}
')
109 return json.loads(self.ydl.urlopen(f'{API_URL}
/{tag}
').read().decode())
112 def current_version(self):
113 """Current version"""
117 def new_version(self):
118 """Version of the latest release we can update to"""
119 if self._tag.startswith('tags
/'):
121 return self._get_version_info(self._tag)['tag_name
']
124 def latest_version(self):
125 """Version of the latest release"""
126 return self._get_version_info('latest
')['tag_name
']
129 def has_update(self):
130 """Whether there is an update available"""
131 return version_tuple(__version__) < version_tuple(self.new_version)
133 @functools.cached_property
135 """Filename of the executable"""
136 return compat_realpath(_get_variant_and_executable_path()[1])
138 def _download(self, name, tag):
139 url = traverse_obj(self._get_version_info(tag), (
140 'assets
', lambda _, v: v['name
'] == name, 'browser_download_url
'), get_all=False)
142 raise Exception('Unable to find download URL
')
143 self.ydl.write_debug(f'Downloading {name}
from {url}
')
144 return self.ydl.urlopen(url).read()
146 @functools.cached_property
147 def release_name(self):
148 """The release filename"""
149 label = _FILE_SUFFIXES[detect_variant()]
150 if label and platform.architecture()[0][:2] == '32':
151 label = f'_x86{label}
'
152 return f'yt
-dlp{label}
'
154 @functools.cached_property
155 def release_hash(self):
156 """Hash of the latest release"""
157 hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2
-256SUMS
', self._tag).decode().splitlines())
158 return hash_data[self.release_name]
160 def _report_error(self, msg, expected=False):
161 self.ydl.report_error(msg, tb=False if expected else None)
163 def _report_permission_error(self, file):
164 self._report_error(f'Unable to write to {file}
; Try running
as administrator
', True)
166 def _report_network_error(self, action, delim=';'):
167 self._report_error(f'Unable to {action}{delim} Visit https
://github
.com
/{REPOSITORY}
/releases
/latest
', True)
169 def check_update(self):
170 """Report whether there is an update available"""
173 f'Latest version
: {self.latest_version}
, Current version
: {self.current_version}
')
174 if not self.has_update:
175 if self._tag == 'latest
':
176 return self.ydl.to_screen(f'yt
-dlp
is up to
date ({__version__}
)')
177 return self.ydl.report_warning(
178 'yt
-dlp cannot be updated any further since you are on an older Python version
')
180 return self._report_network_error('obtain version info
', delim='; Please
try again later
or')
182 if not is_non_updateable():
183 self.ydl.to_screen(f'Current Build Hash {_sha256_file(self.filename)}
')
187 """Update yt-dlp executable to the latest version"""
188 if not self.check_update():
190 err = is_non_updateable()
192 return self._report_error(err, True)
193 self.ydl.to_screen(f'Updating to version {self.new_version}
...')
195 directory = os.path.dirname(self.filename)
196 if not os.access(self.filename, os.W_OK):
197 return self._report_permission_error(self.filename)
198 elif not os.access(directory, os.W_OK):
199 return self._report_permission_error(directory)
201 new_filename, old_filename = f'{self.filename}
.new
', f'{self.filename}
.old
'
202 if detect_variant() == 'zip': # Can be replaced in-place
203 new_filename, old_filename = self.filename, None
206 if os.path.exists(old_filename or ''):
207 os.remove(old_filename)
209 return self._report_error('Unable to remove the old version
')
212 newcontent = self._download(self.release_name, self._tag)
214 return self._report_network_error('download latest version
')
216 return self._report_network_error('fetch updates
')
219 expected_hash = self.release_hash
221 self.ydl.report_warning('no
hash information found
for the release
')
223 if hashlib.sha256(newcontent).hexdigest() != expected_hash:
224 return self._report_network_error('verify the new executable
')
227 with open(new_filename, 'wb
') as outf:
228 outf.write(newcontent)
230 return self._report_permission_error(new_filename)
233 mask = os.stat(self.filename).st_mode
235 os.rename(self.filename, old_filename)
237 return self._report_error('Unable to move current version
')
240 os.rename(new_filename, self.filename)
242 self._report_error('Unable to overwrite current version
')
243 return os.rename(old_filename, self.filename)
245 if detect_variant() in ('win32_exe
', 'py2exe
'):
246 atexit.register(Popen, f'ping
127.0.0.1 -n
5 -w
1000 & del /F
"{old_filename}"',
247 shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
250 os.remove(old_filename)
252 self._report_error('Unable to remove the old version
')
255 os.chmod(self.filename, mask)
257 return self._report_error(
258 f'Unable to
set permissions
. Run
: sudo chmod a
+rx {compat_shlex_quote(self.filename)}
')
260 self.ydl.to_screen(f'Updated yt
-dlp to version {self.new_version}
')
263 @functools.cached_property
265 """The command-line to run the executable, if known"""
266 # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
267 if getattr(sys, 'orig_argv
', None):
269 elif hasattr(sys, 'frozen
'):
273 """Restart the executable"""
274 assert self.cmd, 'Must be frozen
or Py
>= 3.10'
275 self.ydl.write_debug(f'Restarting
: {shell_quote(self.cmd)}
')
276 _, _, returncode = Popen.run(self.cmd)
281 """Update the program file with the latest version from the repository
282 @returns Whether there was a successful update (No update = False)
284 return Updater(ydl).update()
288 def update_self(to_screen, verbose, opener):
291 from .utils import write_string
294 'DeprecationWarning: "yt_dlp.update.update_self" is deprecated
and may be removed
in a future version
. '
295 'Use
"yt_dlp.update.run_update(ydl)" instead
\n')
302 def report_warning(self, msg, *args, **kwargs):
303 return printfn(f'WARNING
: {msg}
', *args, **kwargs)
305 def report_error(self, msg, tb=None):
306 printfn(f'ERROR
: {msg}
')
310 # Copied from YoutubeDL.trouble
311 if sys.exc_info()[0]:
313 if hasattr(sys.exc_info()[1], 'exc_info
') and sys.exc_info()[1].exc_info[0]:
314 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
315 tb += traceback.format_exc()
317 tb_data = traceback.format_list(traceback.extract_stack())
318 tb = ''.join(tb_data)
322 def write_debug(self, msg, *args, **kwargs):
323 printfn(f'[debug
] {msg}
', *args, **kwargs)
325 def urlopen(self, url):
326 return opener.open(url)
328 return run_update(FakeYDL())