From cedeeed56f6ed61646a33e06397f9a059dbc9d90 Mon Sep 17 00:00:00 2001
From: dirkf <fieldhouse@gmx.net>
Date: Fri, 4 Apr 2025 04:42:14 +0100
Subject: [PATCH] [cache] Align further with yt-dlp * use compat_os_makedirs *
support non-ASCII characters in cache key * improve logging
---
test/test_cache.py | 2 +-
youtube_dl/cache.py | 70 ++++++++++++++++++++++++++-------------------
2 files changed, 41 insertions(+), 31 deletions(-)
diff --git a/test/test_cache.py b/test/test_cache.py
index 931074aa1..21dfb6cfc 100644
--- a/test/test_cache.py
+++ b/test/test_cache.py
@@ -63,7 +63,7 @@ class TestCache(unittest.TestCase):
obj = {'x': 1, 'y': ['รค', '\\a', True]}
c.store('test_cache', 'k.', obj)
self.assertEqual(c.load('test_cache', 'k.', min_ver='1970.01.01'), obj)
- new_version = '.'.join(('%d' % ((v + 1) if i == 0 else v, )) for i, v in enumerate(version_tuple(__version__)))
+ new_version = '.'.join(('%0.2d' % ((v + 1) if i == 0 else v, )) for i, v in enumerate(version_tuple(__version__)))
self.assertIs(c.load('test_cache', 'k.', min_ver=new_version), None)
diff --git a/youtube_dl/cache.py b/youtube_dl/cache.py
index 54123da0e..6169461b9 100644
--- a/youtube_dl/cache.py
+++ b/youtube_dl/cache.py
@@ -1,6 +1,6 @@
+# coding: utf-8
from __future__ import unicode_literals
-import errno
import json
import os
import re
@@ -8,14 +8,17 @@ import shutil
import traceback
from .compat import (
+ compat_contextlib_suppress,
compat_getenv,
compat_open as open,
+ compat_os_makedirs,
+ compat_urllib_parse,
)
from .utils import (
error_to_compat_str,
expand_path,
is_outdated_version,
- try_get,
+ traverse_obj,
write_json_file,
)
from .version import __version__
@@ -30,23 +33,36 @@ class Cache(object):
def __init__(self, ydl):
self._ydl = ydl
+ def _write_debug(self, *args, **kwargs):
+ self._ydl.write_debug(*args, **kwargs)
+
+ def _report_warning(self, *args, **kwargs):
+ self._ydl.report_warning(*args, **kwargs)
+
+ def _to_screen(self, *args, **kwargs):
+ self._ydl.to_screen(*args, **kwargs)
+
+ def _get_params(self, k, default=None):
+ return self._ydl.params.get(k, default)
+
def _get_root_dir(self):
- res = self._ydl.params.get('cachedir')
+ res = self._get_params('cachedir')
if res is None:
cache_root = compat_getenv('XDG_CACHE_HOME', '~/.cache')
res = os.path.join(cache_root, self._YTDL_DIR)
return expand_path(res)
def _get_cache_fn(self, section, key, dtype):
- assert re.match(r'^[a-zA-Z0-9_.-]+$', section), \
+ assert re.match(r'^[\w.-]+$', section), \
'invalid section %r' % section
- assert re.match(r'^[a-zA-Z0-9_.-]+$', key), 'invalid key %r' % key
+ key = compat_urllib_parse.quote(
+ key, safe='').replace('%', ',') # encode non-ascii characters
return os.path.join(
self._get_root_dir(), section, '%s.%s' % (key, dtype))
@property
def enabled(self):
- return self._ydl.params.get('cachedir') is not False
+ return self._get_params('cachedir') is not False
def store(self, section, key, data, dtype='json'):
assert dtype in ('json',)
@@ -56,61 +72,55 @@ class Cache(object):
fn = self._get_cache_fn(section, key, dtype)
try:
- try:
- os.makedirs(os.path.dirname(fn))
- except OSError as ose:
- if ose.errno != errno.EEXIST:
- raise
+ compat_os_makedirs(os.path.dirname(fn), exist_ok=True)
+ self._write_debug('Saving {section}.{key} to cache'.format(section=section, key=key))
write_json_file({self._VERSION_KEY: __version__, 'data': data}, fn)
except Exception:
tb = traceback.format_exc()
- self._ydl.report_warning(
- 'Writing cache to %r failed: %s' % (fn, tb))
+ self._report_warning('Writing cache to {fn!r} failed: {tb}'.format(fn=fn, tb=tb))
def _validate(self, data, min_ver):
- version = try_get(data, lambda x: x[self._VERSION_KEY])
+ version = traverse_obj(data, self._VERSION_KEY)
if not version: # Backward compatibility
data, version = {'data': data}, self._DEFAULT_VERSION
if not is_outdated_version(version, min_ver or '0', assume_new=False):
return data['data']
- self._ydl.to_screen(
- 'Discarding old cache from version {version} (needs {min_ver})'.format(**locals()))
+ self._write_debug('Discarding old cache from version {version} (needs {min_ver})'.format(version=version, min_ver=min_ver))
- def load(self, section, key, dtype='json', default=None, min_ver=None):
+ def load(self, section, key, dtype='json', default=None, **kw_min_ver):
assert dtype in ('json',)
+ min_ver = kw_min_ver.get('min_ver')
if not self.enabled:
return default
cache_fn = self._get_cache_fn(section, key, dtype)
- try:
+ with compat_contextlib_suppress(IOError): # If no cache available
try:
- with open(cache_fn, 'r', encoding='utf-8') as cachef:
+ with open(cache_fn, encoding='utf-8') as cachef:
+ self._write_debug('Loading {section}.{key} from cache'.format(section=section, key=key), only_once=True)
return self._validate(json.load(cachef), min_ver)
- except ValueError:
+ except (ValueError, KeyError):
try:
file_size = os.path.getsize(cache_fn)
except (OSError, IOError) as oe:
file_size = error_to_compat_str(oe)
- self._ydl.report_warning(
- 'Cache retrieval from %s failed (%s)' % (cache_fn, file_size))
- except IOError:
- pass # No cache available
+ self._report_warning('Cache retrieval from %s failed (%s)' % (cache_fn, file_size))
return default
def remove(self):
if not self.enabled:
- self._ydl.to_screen('Cache is disabled (Did you combine --no-cache-dir and --rm-cache-dir?)')
+ self._to_screen('Cache is disabled (Did you combine --no-cache-dir and --rm-cache-dir?)')
return
cachedir = self._get_root_dir()
if not any((term in cachedir) for term in ('cache', 'tmp')):
- raise Exception('Not removing directory %s - this does not look like a cache dir' % cachedir)
+ raise Exception('Not removing directory %s - this does not look like a cache dir' % (cachedir,))
- self._ydl.to_screen(
- 'Removing cache dir %s .' % cachedir, skip_eol=True)
+ self._to_screen(
+ 'Removing cache dir %s .' % (cachedir,), skip_eol=True, ),
if os.path.exists(cachedir):
- self._ydl.to_screen('.', skip_eol=True)
+ self._to_screen('.', skip_eol=True)
shutil.rmtree(cachedir)
- self._ydl.to_screen('.')
+ self._to_screen('.')