9 from .utils
import expand_path
, traverse_obj
, version_tuple
, write_json_file
10 from .version
import __version__
14 def __init__(self
, ydl
):
17 def _get_root_dir(self
):
18 res
= self
._ydl
.params
.get('cachedir')
20 cache_root
= os
.getenv('XDG_CACHE_HOME', '~/.cache')
21 res
= os
.path
.join(cache_root
, 'yt-dlp')
22 return expand_path(res
)
24 def _get_cache_fn(self
, section
, key
, dtype
):
25 assert re
.match(r
'^[a-zA-Z0-9_.-]+$', section
), \
26 'invalid section %r' % section
27 assert re
.match(r
'^[a-zA-Z0-9_.-]+$', key
), 'invalid key %r' % key
29 self
._get
_root
_dir
(), section
, f
'{key}.{dtype}')
33 return self
._ydl
.params
.get('cachedir') is not False
35 def store(self
, section
, key
, data
, dtype
='json'):
36 assert dtype
in ('json',)
41 fn
= self
._get
_cache
_fn
(section
, key
, dtype
)
44 os
.makedirs(os
.path
.dirname(fn
))
45 except OSError as ose
:
46 if ose
.errno
!= errno
.EEXIST
:
48 self
._ydl
.write_debug(f
'Saving {section}.{key} to cache')
49 write_json_file({'yt-dlp_version': __version__, 'data': data}
, fn
)
51 tb
= traceback
.format_exc()
52 self
._ydl
.report_warning(f
'Writing cache to {fn!r} failed: {tb}')
54 def _validate(self
, data
, min_ver
):
55 version
= traverse_obj(data
, 'yt-dlp_version')
56 if not version
: # Backward compatibility
57 data
, version
= {'data': data}
, '2022.08.19'
58 if not min_ver
or version_tuple(version
) >= version_tuple(min_ver
):
60 self
._ydl
.write_debug(f
'Discarding old cache from version {version} (needs {min_ver})')
62 def load(self
, section
, key
, dtype
='json', default
=None, *, min_ver
=None):
63 assert dtype
in ('json',)
68 cache_fn
= self
._get
_cache
_fn
(section
, key
, dtype
)
69 with contextlib
.suppress(OSError):
71 with open(cache_fn
, encoding
='utf-8') as cachef
:
72 self
._ydl
.write_debug(f
'Loading {section}.{key} from cache')
73 return self
._validate
(json
.load(cachef
), min_ver
)
74 except (ValueError, KeyError):
76 file_size
= os
.path
.getsize(cache_fn
)
79 self
._ydl
.report_warning(f
'Cache retrieval from {cache_fn} failed ({file_size})')
85 self
._ydl
.to_screen('Cache is disabled (Did you combine --no-cache-dir and --rm-cache-dir?)')
88 cachedir
= self
._get
_root
_dir
()
89 if not any((term
in cachedir
) for term
in ('cache', 'tmp')):
90 raise Exception('Not removing directory %s - this does not look like a cache dir' % cachedir
)
93 'Removing cache dir %s .' % cachedir
, skip_eol
=True)
94 if os
.path
.exists(cachedir
):
95 self
._ydl
.to_screen('.', skip_eol
=True)
96 shutil
.rmtree(cachedir
)
97 self
._ydl
.to_screen('.')