feat(HTML)!: `HTML` class no longer inherits from `str` #86

schloerke · 2024-04-22T21:21:51Z

Breaking changes

HTML no longer inherits from str. It now inherits from collections.UserString. This was done to avoid confusion between str and HTML objects. (feat(HTML)!: HTML class no longer inherits from str #86)
Tag and TagList's method .get_html_string() now both return str instead of HTML. (feat(HTML)!: HTML class no longer inherits from str #86)
Strings added to HTML objects, now return HTML objects. E.g. HTML_value + str_value and str_value_ + HTML_value both return HTML objects. To maintain a str result, call str() on your HTML objects before adding them to strings. (feat(HTML)!: HTML class no longer inherits from str #86)

New features

Exported ReprHtml protocol class. If an object has a _repr_html_ method, then it is of instance ReprHtml. (feat(HTML)!: HTML class no longer inherits from str #86)
Exported is_tag_node() and is_tag_child() functions that utilize typing.TypeIs to narrow TagNode and TagChild type variables, respectively. (feat(HTML)!: HTML class no longer inherits from str #86)
Exported consolidate_attrs(*args, **kwargs) function. This function will combine the TagAttrs (supplied in *args) with TagAttrValues (supplied in **kwargs) into a single TagAttrs object. In addition, it will also return all *args that are not dictionary as a list of unaltered TagChild objects. (feat(HTML)!: HTML class no longer inherits from str #86)
The Tag method .add_style(style=) added support for HTML objects in addition to str values. (feat(HTML)!: HTML class no longer inherits from str #86)

Benefits:

No ambiguity between a str type and an HTML type.

Related py-shiny PRs in prep for this PR:

If a non-HTML value is added to an HTML value, the non-HTML value is escaped Fixes #15

…ngs of the tagified values

Co-Authored-By: Winston Chang <[email protected]>

htmltools/_core.py

…ev/py-shiny#1692

… not find it

schloerke · 2024-09-19T06:50:08Z

htmltools/_core.py

@@ -87,7 +97,7 @@ class MetadataNode:

 TagT = TypeVar("TagT", bound="Tag")

-TagAttrValue = Union[str, float, bool, None]
+TagAttrValue = Union[str, float, bool, "HTML", None]


Given parity for other large union objects (TagNode and TagChild), I do not believe we should make a is_tag_attr_value() method as consolidate_attrs() should internally handle it.

For now, we will skip making this helper method.

schloerke · 2024-09-19T06:51:38Z

htmltools/_core.py

 @runtime_checkable
 class Tagifiable(Protocol):
    """
    Objects with `tagify()` methods are considered `Tagifiable`. Note that an object
    returns a `TagList`, the children of the `TagList` must also be tagified.
    """

-    def tagify(self) -> "TagList | Tag | MetadataNode | str": ...
+    def tagify(self) -> "TagList | Tag | MetadataNode | str | HTML": ...


New HTML() support!

schloerke · 2024-09-19T06:51:56Z

htmltools/_core.py

@@ -87,7 +97,7 @@ class MetadataNode:

 TagT = TypeVar("TagT", bound="Tag")

-TagAttrValue = Union[str, float, bool, None]
+TagAttrValue = Union[str, float, bool, "HTML", None]


New HTML() support!

schloerke · 2024-09-19T06:52:29Z

htmltools/_core.py

@@ -394,7 +486,7 @@ def _repr_html_(self) -> str:
 # =============================================================================
 # TagAttrDict class
 # =============================================================================
-class TagAttrDict(Dict[str, str]):
+class TagAttrDict(Dict[str, "str | HTML"]):


New HTML() support!

schloerke · 2024-09-19T06:52:54Z

htmltools/_core.py

@@ -453,15 +544,17 @@ def _normalize_attr_name(x: str) -> str:
        return x.replace("_", "-")

    @staticmethod
-    def _normalize_attr_value(x: TagAttrValue) -> Optional[str]:
+    def _normalize_attr_value(x: TagAttrValue) -> str | HTML | None:


New HTML() support!

schloerke · 2024-09-19T06:53:25Z

htmltools/_core.py

@@ -689,7 +782,7 @@ def has_class(self, class_: str) -> bool:
        else:
            return False

-    def add_style(self: TagT, style: str, *, prepend: bool = False) -> TagT:
+    def add_style(self: TagT, style: str | HTML, *, prepend: bool = False) -> TagT:


New HTML() support!

schloerke · 2024-09-19T06:54:17Z

htmltools/_core.py

@@ -908,8 +1001,8 @@ def wrap_displayhook_handler(
    def handler_wrapper(value: object) -> None:
        if isinstance(value, (Tag, TagList, Tagifiable)):
            handler(value)
-        elif hasattr(value, "_repr_html_"):
-            handler(HTML(value._repr_html_()))  # pyright: ignore
+        elif isinstance(value, ReprHtml):


Use isinstance() rather than look for the key, which isinstance performs

schloerke · 2024-09-19T06:56:23Z

htmltools/_core.py

+) -> tuple[TagAttrs, list[TagChildT]]: ...
+
+
+def consolidate_attrs(


new helper method (ported from py-shiny)

schloerke · 2024-09-19T06:56:44Z

htmltools/_core.py

+"""
+
+
+def is_tag_node(x: object) -> TypeIs[TagNode]:


New helper method

schloerke · 2024-09-19T06:56:51Z

htmltools/_core.py

+    return isinstance(x, (Tagifiable, MetadataNode, ReprHtml, str, HTML))
+
+
+def is_tag_child(x: object) -> TypeIs[TagChild]:


New helper method

schloerke · 2024-09-19T06:57:07Z

htmltools/_core.py

@@ -1724,7 +1904,7 @@ def _tagchilds_to_tagnodes(x: Iterable[TagChild]) -> list[TagNode]:
    for i, item in enumerate(result):
        if isinstance(item, (int, float)):
            result[i] = str(item)
-        elif not isinstance(item, (Tagifiable, Tag, MetadataNode, ReprHtml, str)):
+        elif not is_tag_node(item):


Using new helper method

htmltools/_core.py

Co-authored-by: Winston Chang <[email protected]>

schloerke added 15 commits April 22, 2024 16:37

Expose ReprHtml class

9117a8a

Formatting

179f103

.get_html_string() now returns str instead of HTML

6b28049

Do not support HTML for attrs

991852f

Update HTML class to not inherit from str

7a2c188

Update CHANGELOG.md

0e2ea4b

Update checkout and setup python to latest versions

ee8b640

Add job to check dev shiny with pypi & dev htmltools

48037ed

TagAttrValue and TagAttrDict now support HTML values

8abe640

If a non-HTML value is added to an HTML value, the non-HTML value is escaped Fixes #15

Make sure single child HTML or text has no white space around it

372f6b2

Loosen type restriction on HTML input object

f25ab9c

bug: Return HTML text when requested

4876bea

Fix failing test; JSX tagified should equal itself, now compares stri…

e6848a2

…ngs of the tagified values

Check dev Shiny w/ dev Htmltools

9f7bae4

Lints

1428c97

schloerke force-pushed the html_not_str branch from 6125268 to 293889f Compare April 23, 2024 16:07

Use editable install of htmltools; Run tests before checking shiny

05531b7

schloerke force-pushed the html_not_str branch from 06b29ca to 05531b7 Compare April 23, 2024 16:16

schloerke and others added 6 commits April 23, 2024 12:37

Add equality method to HTML

05bc8da

Fix bug where html + str resulted in str; Now it returns HTML

b7e2473

Update pytest.yaml

5e4443d

Do not allow HTML in Tag attrs

8d0614c

Remove _html_escape for faicons 0.2.1

633466b

Co-Authored-By: Winston Chang <[email protected]>

Update CHANGELOG.md

855e46d

schloerke marked this pull request as ready for review April 23, 2024 21:39

schloerke requested a review from wch April 23, 2024 21:39

machow reviewed Jun 6, 2024

View reviewed changes

htmltools/_core.py Outdated Show resolved Hide resolved

schloerke added 3 commits September 18, 2024 11:40

Merge branch 'main' into html_not_str

6cde017

Use UserString as base class for HTML

4e164b1

lint

1b658db

schloerke added 12 commits September 18, 2024 16:41

Add another breaking change for HTML type addition

f67f5dc

Export is_tag_node(), is_tag_child() and consolidate_attrs()

4ead746

Update CHANGELOG.md

70f4e06

add_style() added support for receiving HTML objects

19c5eba

Use isinstance(x, ReprHtml) rather than looking for specific field

242da23

Update test_jsx_tags.py

c2cd993

Allow attr values to be HTML

d1ea0e0

Move py-shiny testing to it's own job, away from pytest.yaml

19c4e8c

Use shiny's ci-install-deps target to build faster

90c5a84

Use dev shiny branch for faster debugging

25d5558

Update shiny.yaml

3fc4b1c

Update shiny.yaml

88e4d78

schloerke mentioned this pull request Sep 19, 2024

chore: Add types and check action for py-htmltools posit-dev/py-shiny#1692

Merged

schloerke added 4 commits September 19, 2024 01:58

Update py-shiny dev branch to main. Use new check action from posit-d…

40b7e1c

…ev/py-shiny#1692

checkout htmltools within _dev/htmltools so that py-shiny checks will…

2483d2b

… not find it

auto accept uninstall

2448ede

Revert TagAttrDict changelog entry about not supporting HTML

0d25a1a

schloerke commented Sep 19, 2024

View reviewed changes

Remove outdate changelog

8e0e26c

schloerke commented Sep 19, 2024

View reviewed changes

schloerke requested a review from wch September 19, 2024 06:58

wch reviewed Sep 19, 2024

View reviewed changes

htmltools/_core.py Outdated Show resolved Hide resolved

wch approved these changes Sep 19, 2024

View reviewed changes

schloerke and others added 3 commits September 19, 2024 15:13

Apply suggestions from code review

7f9bdc6

Co-authored-by: Winston Chang <[email protected]>

format comment

86563dc

bump dev version to 0.5.3.9001

f6badbf

schloerke merged commit 81e0749 into main Sep 19, 2024
17 checks passed

schloerke deleted the html_not_str branch September 19, 2024 19:28

This was referenced Sep 27, 2024

feat(TagList)!: TagList now inherits from collections.UserList, instead of typing.List #97

Merged

Epic -- Data frames for v1.2.0 posit-dev/py-shiny#1639

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(HTML)!: `HTML` class no longer inherits from `str` #86

feat(HTML)!: `HTML` class no longer inherits from `str` #86

schloerke commented Apr 22, 2024 •

edited

Loading

schloerke Sep 19, 2024 •

edited

Loading

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

schloerke Sep 19, 2024

		) -> tuple[TagAttrs, list[TagChildT]]: ...


		def consolidate_attrs(

		return isinstance(x, (Tagifiable, MetadataNode, ReprHtml, str, HTML))


		def is_tag_child(x: object) -> TypeIs[TagChild]:

feat(HTML)!: HTML class no longer inherits from str #86

feat(HTML)!: HTML class no longer inherits from str #86

Conversation

schloerke commented Apr 22, 2024 • edited Loading

Breaking changes

New features

schloerke Sep 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat(HTML)!: `HTML` class no longer inherits from `str` #86

feat(HTML)!: `HTML` class no longer inherits from `str` #86

schloerke commented Apr 22, 2024 •

edited

Loading

schloerke Sep 19, 2024 •

edited

Loading