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

Jump to bottom

Fix logic for inferring window title from Tag/TagList objects #138

Merged
merged 3 commits into from
Apr 27, 2022
Merged

Fix logic for inferring window title from Tag/TagList objects #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
195d317
Close #137: fix logic for inferring window title from Tag/TagList obj…
cpsievert Apr 25, 2022
28e4bb6
Add unit test
cpsievert Apr 26, 2022
893cf99
Ignore script/style when searching for strings; make sure 'void' elem…
cpsievert Apr 27, 2022
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
2 changes: 1 addition & 1 deletion shiny/ui/_bootstrap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

from .._docstring import add_example
from ._html_dependencies import jqui_deps
from ._page import get_window_title
from ._utils import get_window_title


# TODO: make a python version of the layout guide?
Expand Down
33 changes: 2 additions & 31 deletions shiny/ui/_page.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,26 @@
)

import sys
from typing import Optional, Any, List, Union, cast
from warnings import warn
from typing import Optional, Any, Union

if sys.version_info >= (3, 8):
from typing import Literal
else:
from typing_extensions import Literal

from htmltools import (
HTMLDependency,
tags,
Tag,
TagList,
div,
TagChildArg,
head_content,
)

from .._docstring import add_example
from ._html_dependencies import bootstrap_deps
from ._navs import navs_bar
from ..types import MISSING, MISSING_TYPE
from ._utils import get_window_title


def page_navbar(
Expand Down Expand Up @@ -127,24 +125,6 @@ def page_navbar(
)


def get_window_title(
title: Optional[Union[str, Tag, TagList]],
window_title: Union[str, MISSING_TYPE] = MISSING,
) -> Optional[HTMLDependency]:
if title is not None and isinstance(window_title, MISSING_TYPE):
# Try to infer window_title from contents of title
window_title = " ".join(_find_characters(title))
if not window_title:
warn(
"Unable to infer a `window_title` default from `title`. Consider providing a character string to `window_title`."
)

if isinstance(window_title, MISSING_TYPE):
return None
else:
return head_content(tags.title(window_title))


@add_example()
def page_fluid(
*args: Any, title: Optional[str] = None, lang: Optional[str] = None, **kwargs: str
Expand Down Expand Up @@ -254,12 +234,3 @@ def page_bootstrap(
page = TagList(*bootstrap_deps(), *args)
head = tags.title(title) if title else None
return tags.html(tags.head(head), tags.body(page), lang=lang)


def _find_characters(x: Any) -> List[str]:
if isinstance(x, str):
return [x]
elif isinstance(x, list):
return [y for y in cast(List[Any], x) if isinstance(y, str)]
else:
return []
38 changes: 37 additions & 1 deletion shiny/ui/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,42 @@
from htmltools import tags, Tag, TagChildArg
from typing import Optional, Union

from htmltools import (
tags,
Tag,
TagList,
TagChildArg,
TagChild,
HTMLDependency,
head_content,
)

from ..types import MISSING, MISSING_TYPE


def shiny_input_label(id: str, label: TagChildArg = None) -> Tag:
cls = "control-label" + ("" if label else " shiny-label-null")
return tags.label(label, class_=cls, id=id + "-label", for_=id)


def get_window_title(
title: Optional[Union[str, Tag, TagList]],
window_title: Union[str, MISSING_TYPE] = MISSING,
) -> Optional[HTMLDependency]:
if title is not None and isinstance(window_title, MISSING_TYPE):
window_title = _find_child_strings(title)

if isinstance(window_title, MISSING_TYPE):
return None
else:
return head_content(tags.title(window_title))


def _find_child_strings(x: Union[Tag, TagList, TagChild]) -> str:
if isinstance(x, Tag) and x.name not in ("script", "style"):
x = x.children
if isinstance(x, TagList):
strings = [_find_child_strings(y) for y in x]
return " ".join(filter(lambda x: x != "", strings))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you filter as part of the list comprehension? [_find_child_strings(y) for y in x if y != ""]

Copy link
Collaborator Author

@cpsievert cpsievert Apr 27, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wish, but it would miss cases where y != "" and _find_child_strings(y) == ""

if isinstance(x, str):
return x
return ""
51 changes: 51 additions & 0 deletions tests/test_ui.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import textwrap

from shiny import ui
from htmltools import HTMLDocument, TagList, tags


def test_panel_title():
x = HTMLDocument(ui.panel_title("Hello Shiny UI")).render()["html"]
assert x == textwrap.dedent(
"""\
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<script type="application/html-dependencies">headcontent_648f698a6bce952fe1b165140306e01f4da9e164[0.0]</script>
<title>Hello Shiny UI</title>
</head>
<body>
<h2>Hello Shiny UI</h2>
</body>
</html>"""
)

title = TagList(
tags.h1("A title"),
tags.script("foo"),
tags.style("foo"),
tags.h5(tags.script("foo"), "A subtitle"),
)

x = HTMLDocument(ui.panel_title(title)).render()["html"]
assert x == textwrap.dedent(
"""\
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<script type="application/html-dependencies">headcontent_9e055af8ef9fa0fb1ba72eeba8053498fbc0d075[0.0]</script>
<title>A title A subtitle</title>
</head>
<body>
<h1>A title</h1>
<script>foo</script>
<style>foo</style>
<h5>
<script>foo</script>
A subtitle
</h5>
</body>
</html>"""
)