1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
|
"""
Snippet ---8<---.
pymdownx.snippet
Inject snippets
MIT license.
Copyright (c) 2017 Isaac Muse <isaacmuse@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""
from markdown import Extension
from markdown.preprocessors import Preprocessor
import functools
import urllib
import re
import codecs
import os
from . import util
import textwrap
MI = 1024 * 1024 # mebibyte (MiB)
DEFAULT_URL_SIZE = MI * 32
DEFAULT_URL_TIMEOUT = 10.0 # in seconds
DEFAULT_URL_REQUEST_HEADERS = {}
class SnippetMissingError(Exception):
"""Snippet missing exception."""
class SnippetPreprocessor(Preprocessor):
"""Handle snippets in Markdown content."""
RE_ALL_SNIPPETS = re.compile(
r'''(?x)
^(?P<space>[ \t]*)
(?P<escape>;*)
(?P<all>
(?P<inline_marker>-{1,}8<-{1,}[ \t]+)
(?P<snippet>(?:"(?:\\"|[^"\n\r])+?"|'(?:\\'|[^'\n\r])+?'))(?![ \t]) |
(?P<block_marker>-{1,}8<-{1,})(?![ \t])
)\r?$
'''
)
RE_SNIPPET = re.compile(
r'''(?x)
^(?P<space>[ \t]*)
(?P<snippet>.*?)\r?$
'''
)
RE_SNIPPET_SECTION = re.compile(
r'''(?xi)
^(?P<pre>.*?)
(?P<escape>;*)
(?P<inline_marker>-{1,}8<-{1,}[ \t]+)
(?P<section>\[[ \t]*(?P<type>start|end)[ \t]*:[ \t]*(?P<name>[a-z][-_0-9a-z]*)[ \t]*\])
(?P<post>.*?)$
'''
)
RE_SNIPPET_FILE = re.compile(
r'(?i)(.*?)(?:((?::-?[0-9]*){1,2}(?:(?:,(?=[-0-9:])-?[0-9]*)(?::-?[0-9]*)?)*)|(:[a-z][-_0-9a-z]*))?$'
)
def __init__(self, config, md):
"""Initialize."""
base = config.get('base_path')
if isinstance(base, (str, os.PathLike)):
base = [base]
self.base_path = [os.path.abspath(b) for b in base]
self.restrict_base_path = config['restrict_base_path']
self.encoding = config.get('encoding')
self.check_paths = config.get('check_paths')
self.auto_append = config.get('auto_append')
self.url_download = config['url_download']
self.url_max_size = config['url_max_size']
self.url_timeout = config['url_timeout']
self.url_request_headers = config['url_request_headers']
self.dedent_subsections = config['dedent_subsections']
self.tab_length = md.tab_length
super().__init__()
self.download.cache_clear()
def extract_section(self, section, lines):
"""Extract the specified section from the lines."""
new_lines = []
start = False
found = False
for l in lines:
# Found a snippet section marker with our specified name
m = self.RE_SNIPPET_SECTION.match(l)
# Handle escaped line
if m and start and m.group('escape'):
l = (
m.group('pre') + m.group('escape').replace(';', '', 1) + m.group('inline_marker') +
m.group('section') + m.group('post')
)
# Found a section we are looking for.
elif m is not None and m.group('name') == section:
# We found the start
if not start and m.group('type') == 'start':
start = True
found = True
continue
# Ignore duplicate start
elif start and m.group('type') == 'start':
continue
# We found the end
elif start and m.group('type') == 'end':
start = False
break
# We found an end, but no start
else:
break
# Found a section we don't care about, so ignore it.
elif m and start:
continue
# We are currently in a section, so append the line
if start:
new_lines.append(l)
if not found and self.check_paths:
raise SnippetMissingError(f"Snippet section '{section}' could not be located")
return self.dedent(new_lines) if self.dedent_subsections else new_lines
def dedent(self, lines):
"""De-indent lines."""
return textwrap.dedent('\n'.join(lines)).split('\n')
def get_snippet_path(self, path):
"""Get snippet path."""
snippet = None
for base in self.base_path:
if os.path.exists(base):
if os.path.isdir(base):
if self.restrict_base_path:
filename = os.path.abspath(os.path.join(base, path))
# If the absolute path is no longer under the specified base path, reject the file
if not filename.startswith(base):
continue
else:
filename = os.path.join(base, path)
if os.path.exists(filename):
snippet = filename
break
else:
dirname = os.path.dirname(base)
filename = os.path.join(dirname, path)
if os.path.exists(filename) and os.path.samefile(filename, base):
snippet = filename
break
return snippet
@functools.lru_cache # noqa: B019
def download(self, url):
"""
Actually download the snippet pointed to by the passed URL.
The most recently used files are kept in a cache until the next reset.
"""
http_request = urllib.request.Request(url, headers=self.url_request_headers)
timeout = None if self.url_timeout == 0 else self.url_timeout
with urllib.request.urlopen(http_request, timeout=timeout) as response:
# Fail if status is not OK
status = response.status if util.PY39 else response.code
if status != 200:
raise SnippetMissingError(f"Cannot download snippet '{url}'")
# We provide some basic protection against absurdly large files.
# 32MB is chosen as an arbitrary upper limit. This can be raised if desired.
content = None
if "content-length" not in response.headers:
# we have to read to know if we went over the max, but never more than `url_max_size`
# where `url_max_size` == 0 means unlimited
content = response.read(self.url_max_size) if self.url_max_size != 0 else response.read()
content_length = len(content)
else:
content_length = int(response.headers["content-length"])
if self.url_max_size != 0 and content_length >= self.url_max_size:
raise ValueError(f"refusing to read payloads larger than or equal to {self.url_max_size}")
# Nothing to return
if content_length == 0:
return ['']
if content is None:
# content-length was in the header, so we did not read yet
content = response.read()
# Process lines
last = content.endswith((b'\r', b'\n'))
s_lines = [l.decode(self.encoding) for l in content.splitlines()]
if last:
s_lines.append('')
return s_lines
def parse_snippets(self, lines, file_name=None, is_url=False, is_section=False):
"""Parse snippets snippet."""
if file_name:
# Track this file.
self.seen.add(file_name)
new_lines = []
inline = False
block = False
for line in lines:
# Check for snippets on line
inline = False
m = self.RE_ALL_SNIPPETS.match(line)
if m:
if m.group('escape'):
# The snippet has been escaped, replace first `;` and continue.
new_lines.append(line.replace(';', '', 1))
continue
if block and m.group('inline_marker'):
# Don't use inline notation directly under a block.
# It's okay if inline is used again in sub file though.
continue
elif m.group('inline_marker'):
# Inline
inline = True
else:
# Block
block = not block
continue
elif not block:
if not is_section:
# Check for section line, if present remove, if escaped, reformat it
m2 = self.RE_SNIPPET_SECTION.match(line)
if m2 and m2.group('escape'):
line = (
m2.group('pre') + m2.group('escape').replace(';', '', 1) + m2.group('inline_marker') +
m2.group('section') + m2.group('post')
)
m2 = None
# Found a section that must be removed
if m2 is not None:
continue
# Not in snippet, and we didn't find an inline,
# so just a normal line
new_lines.append(line)
continue
if block and not inline:
# We are in a block and we didn't just find a nested inline
# So check if a block path
m = self.RE_SNIPPET.match(line)
if m:
# Get spaces and snippet path. Remove quotes if inline.
space = m.group('space').expandtabs(self.tab_length)
path = m.group('snippet')[1:-1].strip() if inline else m.group('snippet').strip()
if not inline:
# Block path handling
if not path:
# Empty path line, insert a blank line
new_lines.append('')
continue
# Ignore commented out lines
if path.startswith(';'):
continue
# Get line numbers (if specified)
end = []
start = []
section = None
m = self.RE_SNIPPET_FILE.match(path)
path = '' if m is None else m.group(1).strip()
# Looks like we have an empty file and only lines specified
if not path:
if self.check_paths:
raise SnippetMissingError(f"Snippet at path '{path}' could not be found")
else:
continue
if m.group(2):
for nums in m.group(2)[1:].split(','):
span = nums.split(':')
st = int(span[0]) if span[0] else None
start.append(st if st is None or st < 0 else max(0, st - 1))
en = int(span[1]) if len(span) > 1 and span[1] else None
end.append(en)
elif m.group(3):
section = m.group(3)[1:]
# Ignore path links if we are in external, downloaded content
is_link = path.lower().startswith(('https://', 'http://'))
if is_url and not is_link:
continue
# If this is a link, and we are allowing URLs, set `url` to true.
# Make sure we don't process `path` as a local file reference.
url = self.url_download and is_link
snippet = self.get_snippet_path(path) if not url else path
if snippet:
# This is in the stack and we don't want an infinite loop!
if snippet in self.seen:
continue
if not url:
# Read file content
with codecs.open(snippet, 'r', encoding=self.encoding) as f:
last = False
s_lines = []
for l in f:
last = l.endswith(('\r', '\n'))
s_lines.append(l.strip('\r\n'))
if last:
s_lines.append('')
else:
# Read URL content
try:
s_lines = self.download(snippet)
except SnippetMissingError:
if self.check_paths:
raise
s_lines = []
if s_lines:
total = len(s_lines)
if start and end:
final_lines = []
for sel in zip(start, end):
s_start = util.clamp(total + sel[0], 0, total) if sel[0] and sel[0] < 0 else sel[0]
s_end = util.clamp(total + 1 + sel[1], 0, total) if sel[1] and sel[1] < 0 else sel[1]
final_lines.extend(s_lines[slice(s_start, s_end, None)])
s_lines = self.dedent(final_lines) if self.dedent_subsections else final_lines
elif section:
s_lines = self.extract_section(section, s_lines)
# Process lines looking for more snippets
new_lines.extend(
[
space + l2 for l2 in self.parse_snippets(
s_lines,
snippet,
is_url=url,
is_section=section is not None
)
]
)
elif self.check_paths:
raise SnippetMissingError(f"Snippet at path '{path}' could not be found")
# Pop the current file name out of the cache
if file_name:
self.seen.remove(file_name)
return new_lines
def run(self, lines):
"""Process snippets."""
self.seen = set()
if self.auto_append:
lines.extend("\n\n-8<-\n{}\n-8<-\n".format('\n\n'.join(self.auto_append)).split('\n'))
return self.parse_snippets(lines)
class SnippetExtension(Extension):
"""Snippet extension."""
def __init__(self, *args, **kwargs):
"""Initialize."""
self.config = {
'base_path': [["."], "Base path for snippet paths - Default: [\".\"]"],
'restrict_base_path': [
True,
"Restrict snippet paths such that they are under the base paths - Default: True"
],
'encoding': ["utf-8", "Encoding of snippets - Default: \"utf-8\""],
'check_paths': [False, "Make the build fail if a snippet can't be found - Default: \"False\""],
"auto_append": [
[],
"A list of snippets (relative to the 'base_path') to auto append to the Markdown content - Default: []"
],
'url_download': [False, "Download external URLs as snippets - Default: \"False\""],
'url_max_size': [DEFAULT_URL_SIZE, "External URL max size (0 means no limit)- Default: 32 MiB"],
'url_timeout': [DEFAULT_URL_TIMEOUT, 'Defualt URL timeout (0 means no timeout) - Default: 10 sec'],
'url_request_headers': [DEFAULT_URL_REQUEST_HEADERS, "Extra request Headers - Default: {}"],
'dedent_subsections': [False, "Dedent subsection extractions e.g. 'sections' and/or 'lines'."]
}
super().__init__(*args, **kwargs)
def extendMarkdown(self, md):
"""Register the extension."""
self.md = md
md.registerExtension(self)
config = self.getConfigs()
snippet = SnippetPreprocessor(config, md)
md.preprocessors.register(snippet, "snippet", 32)
def reset(self):
"""Reset."""
self.md.preprocessors['snippet'].download.cache_clear()
def makeExtension(*args, **kwargs):
"""Return extension."""
return SnippetExtension(*args, **kwargs)
|