Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support markup protocol in the preview filter (for markdown composite) #484

Merged
merged 1 commit into from
May 2, 2024
Merged

Support markup protocol in the preview filter (for markdown composite) #484

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/baseframe/filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,15 @@ def preview(html: str, min: int = 50, max: int = 158) -> str: # noqa: A002
:param int max: Maximum number of characters in the preview (default 158,
recommended for Google)
"""
# Check if we got a string-like object that implements the `__html__` protocol, and
# use that. This is the case for Coaster's Markdown Composite, where the text and
# html variants are different strings, so we can't use `str(html)` to get the text.
if callable(htmlfunc := getattr(html, '__html__', None)):
html = htmlfunc()
# Get the max length we're interested in, for efficiency in grapheme counts. A large
# blob of text can impair performance if we're only interested in a small preview.
# `max` can be < `min` when the caller specifies a custom `max` without `min`
# `max` can be < `min` when the caller specifies a custom `max` without `min`. In
# this case, we use `min`.
max_length = (max if max > min else min) + 1
blocks = text_blocks(html)
if blocks:
Expand Down
Loading