mirror of
https://github.com/mkdocs/mkdocs.git
synced 2026-03-27 09:58:31 +07:00
36205e30dd
The user story is that the following command should let you "just build" any MkDocs site:
pip install $(mkdocs get-deps) && mkdocs build
This cross-references 2 files:
* mkdocs.yml - `theme`, `plugins`, `markdown_extensions`
* projects.yaml - a registry of all popular MkDocs-related projects and which entry points they provide - downloaded on the fly
-and prints the names of Python packages from PyPI that need to be installed to build the current MkDocs project
65 lines
2.2 KiB
Python
65 lines
2.2 KiB
Python
import datetime
|
|
import hashlib
|
|
import logging
|
|
import os
|
|
import urllib.parse
|
|
import urllib.request
|
|
|
|
import click
|
|
import platformdirs
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
def download_and_cache_url(
|
|
url: str,
|
|
cache_duration: datetime.timedelta,
|
|
comment: bytes = b'# ',
|
|
) -> bytes:
|
|
"""
|
|
Downloads a file from the URL, stores it under ~/.cache/, and returns its content.
|
|
|
|
If the URL is a local path, it is simply read and returned instead.
|
|
|
|
For tracking the age of the content, a prefix is inserted into the stored file, rather than relying on mtime.
|
|
|
|
Parameters:
|
|
url: URL or local path of the file to use.
|
|
cache_duration: how long to consider the URL content cached.
|
|
comment: The appropriate comment prefix for this file format.
|
|
"""
|
|
|
|
if urllib.parse.urlsplit(url).scheme not in ('http', 'https'):
|
|
with open(url, 'rb') as f:
|
|
return f.read()
|
|
|
|
directory = os.path.join(platformdirs.user_cache_dir('mkdocs'), 'mkdocs_url_cache')
|
|
name_hash = hashlib.sha256(url.encode()).hexdigest()[:32]
|
|
path = os.path.join(directory, name_hash + os.path.splitext(url)[1])
|
|
|
|
now = int(datetime.datetime.now(datetime.timezone.utc).timestamp())
|
|
prefix = b'%s%s downloaded at timestamp ' % (comment, url.encode())
|
|
# Check for cached file and try to return it
|
|
if os.path.isfile(path):
|
|
try:
|
|
with open(path, 'rb') as f:
|
|
line = f.readline()
|
|
if line.startswith(prefix):
|
|
line = line[len(prefix) :]
|
|
timestamp = int(line)
|
|
if datetime.timedelta(seconds=(now - timestamp)) <= cache_duration:
|
|
log.debug(f"Using cached '{path}' for '{url}'")
|
|
return f.read()
|
|
except (IOError, ValueError) as e:
|
|
log.debug(f'{type(e).__name__}: {e}')
|
|
|
|
# Download and cache the file
|
|
log.debug(f"Downloading '{url}' to '{path}'")
|
|
with urllib.request.urlopen(url) as resp:
|
|
content = resp.read()
|
|
os.makedirs(directory, exist_ok=True)
|
|
with click.open_file(path, 'wb', atomic=True) as f:
|
|
f.write(b'%s%d\n' % (prefix, now))
|
|
f.write(content)
|
|
return content
|