mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 05:53:43 +00:00
4b8c99b01a
Renames misleading attribute in HTML template using `code-section` to refer to both language toggles in API docs and app toggles in help center docs.
40 lines
1.3 KiB
Python
40 lines
1.3 KiB
Python
from typing import Mapping, Union
|
|
|
|
from bs4 import BeautifulSoup
|
|
from django.http import HttpRequest
|
|
from django.utils.html import escape
|
|
|
|
from zerver.lib.cache import cache_with_key, open_graph_description_cache_key
|
|
|
|
|
|
def html_to_text(content: Union[str, bytes], tags: Mapping[str, str] = {"p": " | "}) -> str:
|
|
bs = BeautifulSoup(content, features="lxml")
|
|
# Skip any admonition (warning) blocks, since they're
|
|
# usually something about users needing to be an
|
|
# organization administrator, and not useful for
|
|
# describing the page.
|
|
for tag in bs.find_all("div", class_="admonition"):
|
|
tag.clear()
|
|
|
|
# Skip tabbed-sections, which just contain navigation instructions.
|
|
for tag in bs.find_all("div", class_="tabbed-section"):
|
|
tag.clear()
|
|
|
|
text = ""
|
|
for element in bs.find_all(tags.keys()):
|
|
# Ignore empty elements
|
|
if not element.text:
|
|
continue
|
|
# .text converts it from HTML to text
|
|
if text:
|
|
text += tags[element.name]
|
|
text += element.text
|
|
if len(text) > 500:
|
|
break
|
|
return escape(" ".join(text.split()))
|
|
|
|
|
|
@cache_with_key(open_graph_description_cache_key, timeout=3600 * 24)
|
|
def get_content_description(content: bytes, request: HttpRequest) -> str:
|
|
return html_to_text(content)
|