langfun 0.0.2.dev20240608__py3-none-any.whl → 0.0.2.dev20240610__py3-none-any.whl

langfun/core/__init__.py

@@ -121,6 +121,9 @@ from langfun.core.memory import Memory
 # Utility for console output.
 from langfun.core import console
 
+# Helpers for implementing _repr_xxx_ methods.
+from langfun.core import repr_utils
+
 # Utility for event logging.
 from langfun.core import logging
 

langfun/core/repr_utils.py

@@ -0,0 +1,83 @@
+# Copyright 2024 The Langfun Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Helpers for implementing _repr_xxx_ methods."""
+
+import collections
+import contextlib
+import io
+from typing import Iterator
+
+from langfun.core import component
+
+
+@contextlib.contextmanager
+def share_parts() -> Iterator[dict[str, int]]:
+  """Context manager for defining the context (scope) of shared content.
+
+  Under the context manager, call to `lf.write_shared` with the same content
+  will be written only once. This is useful for writing shared content such as
+  shared style and script sections in the HTML.
+
+  Example:
+    ```
+    class Foo(pg.Object):
+      def _repr_html_(self) -> str:
+        s = io.StringIO()
+        lf.repr_utils.write_shared_part(s, '<style>..</style>')
+        lf.repr_utils.write_shared_part(s, '<script>..</script>')
+        return s.getvalue()
+
+    with lf.repr_utils.share_parts() as share_parts:
+      # The <style> and <script> section will be written only once.
+      lf.console.display(Foo())
+      lf.console.display(Foo())
+
+    # Assert that the shared content is attempted to be written twice.
+    assert share_parts['<style>..</style>'] == 2
+    ```
+
+  Yields:
+    A dictionary mapping the shared content to the number of times it is
+    attempted to be written.
+  """
+  context = component.context_value(
+      '__shared_parts__', collections.defaultdict(int)
+  )
+  with component.context(__shared_parts__=context):
+    try:
+      yield context
+    finally:
+      pass
+
+
+def write_maybe_shared(s: io.StringIO, content: str) -> bool:
+  """Writes a maybe shared part to an string stream.
+
+  Args:
+    s: The string stream to write to.
+    content: A maybe shared content to write.
+
+  Returns:
+    True if the content is written to the string. False if the content is
+    already written under the same share context.
+  """
+  context = component.context_value('__shared_parts__', None)
+  if context is None:
+    s.write(content)
+    return True
+  written = content in context
+  if not written:
+    s.write(content)
+  context[content] += 1
+  return not written

langfun/core/repr_utils_test.py

@@ -0,0 +1,58 @@
+# Copyright 2024 The Langfun Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Tests for langfun.core.repr_utils."""
+
+import io
+import unittest
+
+from langfun.core import repr_utils
+
+
+class SharingContentTest(unittest.TestCase):
+
+  def test_sharing(self):
+    s = io.StringIO()
+
+    self.assertTrue(repr_utils.write_maybe_shared(s, '<hr>'))
+    self.assertTrue(repr_utils.write_maybe_shared(s, '<hr>'))
+
+    with repr_utils.share_parts() as ctx1:
+      self.assertTrue(repr_utils.write_maybe_shared(s, '<style></style>'))
+      self.assertFalse(repr_utils.write_maybe_shared(s, '<style></style>'))
+
+      with repr_utils.share_parts() as ctx2:
+        self.assertIs(ctx2, ctx1)
+        self.assertFalse(repr_utils.write_maybe_shared(s, '<style></style>'))
+        self.assertTrue(repr_utils.write_maybe_shared(s, '<style>a</style>'))
+        self.assertFalse(repr_utils.write_maybe_shared(s, '<style>a</style>'))
+        self.assertTrue(repr_utils.write_maybe_shared(s, '<style>b</style>'))
+
+      with repr_utils.share_parts() as ctx3:
+        self.assertIs(ctx3, ctx1)
+        self.assertFalse(repr_utils.write_maybe_shared(s, '<style></style>'))
+        self.assertFalse(repr_utils.write_maybe_shared(s, '<style>a</style>'))
+        self.assertFalse(repr_utils.write_maybe_shared(s, '<style>a</style>'))
+        self.assertFalse(repr_utils.write_maybe_shared(s, '<style>b</style>'))
+
+    self.assertEqual(
+        s.getvalue(),
+        '<hr><hr><style></style><style>a</style><style>b</style>'
+    )
+    self.assertEqual(ctx1['<style></style>'], 4)
+    self.assertEqual(ctx1['<style>b</style>'], 2)
+    self.assertEqual(ctx1['<style>a</style>'], 4)
+
+
+if __name__ == '__main__':
+  unittest.main()

{langfun-0.0.2.dev20240608.dist-info → langfun-0.0.2.dev20240610.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langfun
-Version: 0.0.2.dev20240608
+Version: 0.0.2.dev20240610
 Summary: Langfun: Language as Functions.
 Home-page: https://github.com/google/langfun
 Author: Langfun Authors

{langfun-0.0.2.dev20240608.dist-info → langfun-0.0.2.dev20240610.dist-info}/RECORD

@@ -1,5 +1,5 @@
 langfun/__init__.py,sha256=P62MnqA6-f0h8iYfQ3MT6Yg7a4qRnQeb4GrIn6dcSnY,2274
-langfun/core/__init__.py,sha256=nFQgTyhNLA83b_V_nPNByyO2JlF576AdS61AfA0SaN8,4728
+langfun/core/__init__.py,sha256=Mdp1a2YnXdSmfTfbUwuAnEWYbjA3rXXGtbxl5fljZyg,4812
 langfun/core/component.py,sha256=Icyoj9ICoJoK2r2PHbrFXbxnseOr9QZZOvKWklLWNo8,10276
 langfun/core/component_test.py,sha256=q15Xn51cVTu2RKxZ9U5VQgT3bm6RQ4638bKhWBtvW5o,8220
 langfun/core/concurrent.py,sha256=TRc49pJ3HQro2kb5FtcWkHjhBm8UcgE8RJybU5cU3-0,24537
@@ -19,6 +19,8 @@ langfun/core/modality.py,sha256=Tla4t86DUYHpbZ2G7dy1r19fTj_Ga5XOvlYp6lbWa-Q,3512
 langfun/core/modality_test.py,sha256=HyZ5xONKQ0Fw18SzoWAq-Ob9njOXIIjBo1hNtw-rudw,2400
 langfun/core/natural_language.py,sha256=3ynSnaYQnjE60LIPK5fyMgdIjubnPYZwzGq4rWPeloE,1177
 langfun/core/natural_language_test.py,sha256=LHGU_1ytbkGuSZQFIFP7vP3dBlcY4-A12fT6dbjUA0E,1424
+langfun/core/repr_utils.py,sha256=HrN7FoGUvpTlv5aL_XISouwZN84z9LmrB6_2jEn1ukc,2590
+langfun/core/repr_utils_test.py,sha256=-XId1A72Vbzo289dYuxC6TegNXuZhI28WbNrm1ghiwc,2206
 langfun/core/sampling.py,sha256=vygWvgC8MFw0_AKNSmz-ywMXJYWf8cl0tI8QycvAmyI,5795
 langfun/core/sampling_test.py,sha256=U7PANpMsl9E_pa4_Y4FzesSjcwg-u-LKHGCWSgv-8FY,3663
 langfun/core/subscription.py,sha256=euawEuSZP-BHydaT-AQpfYFL0m5pWPGcW0upFhrojqc,10930
@@ -115,8 +117,8 @@ langfun/core/templates/demonstration.py,sha256=vCrgYubdZM5Umqcgp8NUVGXgr4P_c-fik
 langfun/core/templates/demonstration_test.py,sha256=SafcDQ0WgI7pw05EmPI2S4v1t3ABKzup8jReCljHeK4,2162
 langfun/core/templates/selfplay.py,sha256=yhgrJbiYwq47TgzThmHrDQTF4nDrTI09CWGhuQPNv-s,2273
 langfun/core/templates/selfplay_test.py,sha256=rBW2Qr8yi-aWYwoTwRR-n1peKyMX9QXPZXURjLgoiRs,2264
-langfun-0.0.2.dev20240608.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-langfun-0.0.2.dev20240608.dist-info/METADATA,sha256=HhaObQS5WL8Y2uRuwNX389KbnRiRPsV3Vl-XzVGTN0A,3550
-langfun-0.0.2.dev20240608.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-langfun-0.0.2.dev20240608.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
-langfun-0.0.2.dev20240608.dist-info/RECORD,,
+langfun-0.0.2.dev20240610.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+langfun-0.0.2.dev20240610.dist-info/METADATA,sha256=IB3ZKHYSs9TGLiJ8_ZEUZGX-dvh_SI8D2RD0ikQYvro,3550
+langfun-0.0.2.dev20240610.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+langfun-0.0.2.dev20240610.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
+langfun-0.0.2.dev20240610.dist-info/RECORD,,