aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/apps/content/utils.py
diff options
context:
space:
mode:
Diffstat (limited to 'pydis_site/apps/content/utils.py')
-rw-r--r--pydis_site/apps/content/utils.py42
1 files changed, 13 insertions, 29 deletions
diff --git a/pydis_site/apps/content/utils.py b/pydis_site/apps/content/utils.py
index db502a71..ef02a8cb 100644
--- a/pydis_site/apps/content/utils.py
+++ b/pydis_site/apps/content/utils.py
@@ -1,65 +1,49 @@
-import os
-from typing import Dict, List, Optional, Union
+from pathlib import Path
+from typing import Dict, Union
import yaml
-from django.conf import settings
from django.http import Http404
from markdown2 import markdown
-def get_category(path: List[str]) -> Dict[str, str]:
+def get_category(path: Path) -> Dict[str, str]:
"""Load category information by name from _info.yml."""
- path = settings.PAGES_PATH.joinpath(*path)
if not path.exists() or not path.is_dir():
raise Http404("Category not found.")
return yaml.safe_load(path.joinpath("_info.yml").read_text())
-def get_categories(path: Optional[List[str]] = None) -> Dict[str, Dict]:
+def get_categories(path: Path) -> Dict[str, Dict]:
"""Get all categories information."""
categories = {}
- if path is None:
- categories_path = settings.PAGES_PATH
- path = []
- else:
- categories_path = settings.PAGES_PATH.joinpath(*path)
- for name in categories_path.iterdir():
+ for name in path.iterdir():
if name.is_dir():
- categories[name.name] = get_category([*path, name.name])
+ categories[name.name] = get_category(path.joinpath(name.name))
return categories
-def get_pages(path: Optional[List[str]] = None) -> Dict[str, Dict]:
- """Get all root or category pages."""
- if path is None:
- base_dir = settings.PAGES_PATH
- else:
- base_dir = settings.PAGES_PATH.joinpath(*path)
-
+def get_pages(path: Path) -> Dict[str, Dict]:
+ """Get all root or category page names and their metadata."""
pages = {}
- for item in base_dir.iterdir():
+ for item in path.iterdir():
if item.is_file() and item.name.endswith(".md"):
md = markdown(item.read_text(), extras=["metadata"])
- pages[os.path.splitext(item.name)[0]] = md.metadata
+ pages[item.stem] = md.metadata
return pages
-def get_page(path: List[str]) -> Dict[str, Union[str, Dict]]:
+def get_page(path: Path) -> Dict[str, Union[str, Dict]]:
"""Get one specific page. When category is specified, get it from there."""
- page_path = settings.PAGES_PATH.joinpath(*path[:-1])
-
- # We need to include extension MD
- page_path = page_path.joinpath(f"{path[-1]}.md")
- if not page_path.exists() or not page_path.is_file():
+ if not path.exists() or not path.is_file():
raise Http404("Page not found.")
html = markdown(
- page_path.read_text(),
+ path.read_text(),
extras=[
"metadata",
"fenced-code-blocks",