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
|
import os
from typing import Dict, Optional, Union
import yaml
from django.conf import settings
from django.http import Http404
from markdown import Markdown
def _get_base_path() -> str:
"""Have extra function for base path getting for testability."""
return os.path.join(settings.BASE_DIR, "pydis_site", "apps", "content", "resources", "content")
def get_category(category: str) -> Dict[str, str]:
"""Load category information by name from _info.yml."""
path = os.path.join(_get_base_path(), category)
if not os.path.exists(path) or not os.path.isdir(path):
raise Http404("Category not found.")
with open(os.path.join(path, "_info.yml")) as f:
return yaml.safe_load(f.read())
def get_categories() -> Dict[str, Dict]:
"""Get all categories information."""
base_path = _get_base_path()
categories = {}
for name in os.listdir(base_path):
if os.path.isdir(os.path.join(base_path, name)):
categories[name] = get_category(name)
return categories
def get_articles(category: Optional[str] = None) -> Dict[str, Dict]:
"""Get all root content when category is not specified. Otherwise get all this category content."""
if category is None:
base_dir = _get_base_path()
else:
base_dir = os.path.join(_get_base_path(), category)
articles = {}
for filename in os.listdir(base_dir):
full_path = os.path.join(base_dir, filename)
if os.path.isfile(full_path) and filename.endswith(".md"):
md = Markdown(extensions=['meta'])
with open(full_path) as f:
md.convert(f.read())
articles[os.path.splitext(filename)[0]] = md.Meta
return articles
def get_article(article: str, category: Optional[str]) -> Dict[str, Union[str, Dict]]:
"""Get one specific article. When category is specified, get it from there."""
if category is None:
base_path = _get_base_path()
else:
base_path = os.path.join(_get_base_path(), category)
if not os.path.exists(base_path) or not os.path.isdir(base_path):
raise Http404("Category not found.")
article_path = os.path.join(base_path, f"{article}.md")
if not os.path.exists(article_path) or not os.path.isfile(article_path):
raise Http404("Article not found.")
md = Markdown(extensions=['meta', 'attr_list', 'fenced_code'])
with open(article_path) as f:
html = md.convert(f.read())
return {"article": html, "metadata": md.Meta}
|
