mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-25 14:08:30 +02:00
Abdon Pijpelinkandxzfc
bcc3c7206b
* Support generating multiple snippets from one source file * Convert Python code snippets from one source file * Add code snippets for C#, Go, Java, Rust and TS * Make intro less Python-oriented * Add client installation instructions for all languages * Cleanup python code --------- Co-authored-by: xzfc <xzfcpw@gmail.com>
90 lines
3.0 KiB
Python
Executable File
90 lines
3.0 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""Converts all runnable snippets to markdown files.
|
|
|
|
E.g., converts
|
|
`snippets/create-collection/simple/python.py`
|
|
to
|
|
`snippets/create-collection/simple/generated/python.md`
|
|
|
|
For using on CI and running before committing changes.
|
|
The reverse is `./migrate-snippet.py`.
|
|
"""
|
|
|
|
import difflib
|
|
import shutil
|
|
import sys
|
|
import textwrap
|
|
import traceback
|
|
import typing
|
|
|
|
from lib import SNIPPETS_DIR, collect_snippets
|
|
from lib.languages import ALL_LANGUAGES
|
|
|
|
|
|
def main() -> None:
|
|
snippets = collect_snippets(bases=[SNIPPETS_DIR], languages=ALL_LANGUAGES)
|
|
|
|
issues = 0
|
|
|
|
for snippet_dir, snippets2 in snippets.items():
|
|
generated_dir = snippet_dir / "generated"
|
|
|
|
shutil.rmtree(generated_dir, ignore_errors=True)
|
|
generated_dir.mkdir()
|
|
|
|
for lang, snippet_fname in snippets2.items():
|
|
try:
|
|
shortened = lang.shorten(snippet_fname.read_text())
|
|
except Exception as e:
|
|
issues += 1
|
|
print(f"Warning: failed to shorten snippet {snippet_fname}: {e}")
|
|
traceback.print_exc()
|
|
continue
|
|
|
|
for key in shortened.keys():
|
|
generated = f"```{lang.NAME}\n{textwrap.dedent(shortened[key])}```\n"
|
|
|
|
generated_dir = snippet_dir / "generated" / key
|
|
generated_dir.mkdir(exist_ok=True)
|
|
generated_fname = generated_dir / f"{lang.NAME}.md"
|
|
handwritten_fname = snippet_dir / f"{lang.NAME}.md"
|
|
generated_fname.write_text(generated)
|
|
|
|
if handwritten_fname.exists():
|
|
issues += 1
|
|
print(
|
|
"Warning: both snippet and generated file exist:",
|
|
snippet_dir / f"{lang.NAME}.md",
|
|
)
|
|
handwritten = (snippet_dir / f"{lang.NAME}.md").read_text()
|
|
if handwritten.rstrip("\n") != generated.rstrip("\n"):
|
|
print_and_colorize_diff(
|
|
difflib.unified_diff(
|
|
handwritten.rstrip("\n").splitlines(keepends=True),
|
|
generated.rstrip("\n").splitlines(keepends=True),
|
|
fromfile=str(handwritten_fname),
|
|
tofile=str(generated_fname),
|
|
),
|
|
)
|
|
print()
|
|
|
|
if issues:
|
|
print(f"Total issues found: {issues}")
|
|
sys.exit(1)
|
|
|
|
|
|
def print_and_colorize_diff(diff: typing.Iterable[str]) -> None:
|
|
for line in diff:
|
|
if line.startswith("+"):
|
|
print(end=f"\x1b[32m{line}\x1b[0m", file=sys.stderr)
|
|
elif line.startswith("-"):
|
|
print(end=f"\x1b[31m{line}\x1b[0m", file=sys.stderr)
|
|
elif line.startswith("@"):
|
|
print(end=f"\x1b[36m{line}\x1b[0m", file=sys.stderr)
|
|
else:
|
|
print(end=line, file=sys.stderr)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|