pyglove 0.4.5.dev202504220810__py3-none-any.whl → 0.4.5.dev202504230810__py3-none-any.whl

pyglove/core/utils/formatting.py

@@ -161,6 +161,7 @@ def kvlist_str(
     label: Optional[str] = None,
     bracket_type: BracketType = BracketType.ROUND,
     custom_format: Optional[CustomFormatFn] = None,
+    memo: Optional[Set[int]] = None,
     **kwargs,
 ) -> str:
   """Formats a list key/value pairs into a comma delimited string.
@@ -178,6 +179,8 @@ def kvlist_str(
     custom_format: An optional custom format function, which will be applied to
       each value (and child values) in kvlist. If the function returns None, it
       will fall back to the default `pg.format`.
+    memo: A set of object ids that have been formatted. Used to avoid
+      infinite recursion in the formatting process.
     **kwargs: Keyword arguments that will be passed through unto child
       ``Formattable`` objects.
   Returns:
@@ -208,6 +211,7 @@ def kvlist_str(
           verbose=verbose,
           root_indent=child_indent,
           custom_format=custom_format,
+          memo=memo,
           **kwargs
       )
       if not compact:
@@ -271,6 +275,7 @@ def format(   # pylint: disable=redefined-builtin
     max_bytes_len: Optional[int] = None,
     *,
     custom_format: Optional[CustomFormatFn] = None,
+    memo: Optional[Set[int]] = None,
     **kwargs,
 ) -> str:
   """Formats a (maybe) hierarchical value with flags.
@@ -297,6 +302,8 @@ def format(   # pylint: disable=redefined-builtin
     custom_format: An optional custom format function, which will be applied to
       each value (and child values) in kvlist. If the function returns None, it
       will fall back to the default `pg.format`.
+    memo: A set of object ids that have been formatted. Used to avoid
+      infinite recursion in the formatting process.
     **kwargs: Keyword arguments that will be passed through unto child
       ``Formattable`` objects.
 
@@ -309,6 +316,14 @@ def format(   # pylint: disable=redefined-builtin
     if result is not None:
       return maybe_markdown_quote(result, markdown)
 
+  if memo is None:
+    memo = set()
+
+  id_ = id(value)
+  if id_ in memo:
+    return f'<recursive {value.__class__.__name__} at 0x{id_:x}>'  # pylint: disable=bad-whitespace
+  memo.add(id_)
+
   exclude_keys = exclude_keys or set()
 
   def _should_include_key(key: str) -> bool:
@@ -327,6 +342,7 @@ def format(   # pylint: disable=redefined-builtin
         max_str_len=max_str_len,
         max_bytes_len=max_bytes_len,
         custom_format=custom_format,
+        memo=memo,
         **kwargs
     )
 
@@ -345,6 +361,7 @@ def format(   # pylint: disable=redefined-builtin
           max_str_len=max_str_len,
           max_bytes_len=max_bytes_len,
           custom_format=custom_format,
+          memo=memo,
           **kwargs
       )
     elif isinstance(value, (list, tuple)):
@@ -393,6 +410,7 @@ def format(   # pylint: disable=redefined-builtin
              if compact else str_ext(value, custom_format, root_indent)]
         if strip_object_id and 'object at 0x' in s[-1]:
           s = [f'{value.__class__.__name__}(...)']
+  memo.remove(id_)
   return maybe_markdown_quote(''.join(s), markdown)
 
 
@@ -454,10 +472,10 @@ def camel_to_snake(text: str, separator: str = '_') -> str:
   return (separator.join(c for c in chunks if c)).lower()
 
 
-def printv(v: Any, **kwargs):
+def printv(*args, **kwargs):
   """Prints formatted value."""
   fs = kwargs.pop('file', sys.stdout)
-  print(format(v, **kwargs), file=fs)
+  print(*[format(v, **kwargs) for v in args], file=fs)
 
 
 def _indent(text: str, indent: int) -> str:

pyglove/core/utils/formatting_test.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import inspect
+import io
 import unittest
 
 from pyglove.core.utils import formatting
@@ -408,6 +409,26 @@ class FormatTest(unittest.TestCase):
         '{\'x\': <a/>}'
     )
 
+  def test_recursion(self):
+    # Recursive dict.
+    x = dict(x=1)
+    x['y'] = x
+    self.assertEqual(
+        formatting.format(x, compact=True),
+        f'{{\'x\': 1, \'y\': <recursive dict at 0x{id(x):x}>}}'
+    )
+    self.assertEqual(
+        formatting.format(x, compact=False),
+        f'{{\n  \'x\': 1,\n  \'y\': <recursive dict at 0x{id(x):x}>\n}}'
+    )
+    # Non-recursive dict.
+    y = dict(x=1)
+    a = dict(x=y, y=y)
+    self.assertEqual(
+        formatting.format(a, compact=True),
+        '{\'x\': {\'x\': 1}, \'y\': {\'x\': 1}}'
+    )
+
   def test_markdown(self):
 
     class A(formatting.Formattable):
@@ -448,6 +469,11 @@ class FormatTest(unittest.TestCase):
         formatting.format(b'bar', max_bytes_len=2), 'b\'ba...\''
     )
 
+  def test_printv(self):
+    with io.StringIO() as f:
+      formatting.printv(1, 2, 3, file=f)
+      self.assertEqual(f.getvalue(), '1 2 3\n')
+
 
 if __name__ == '__main__':
   unittest.main()

{pyglove-0.4.5.dev202504220810.dist-info → pyglove-0.4.5.dev202504230810.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyglove
-Version: 0.4.5.dev202504220810
+Version: 0.4.5.dev202504230810
 Summary: PyGlove: A library for manipulating Python objects.
 Home-page: https://github.com/google/pyglove
 Author: PyGlove Authors

{pyglove-0.4.5.dev202504220810.dist-info → pyglove-0.4.5.dev202504230810.dist-info}/RECORD

@@ -139,8 +139,8 @@ pyglove/core/utils/docstr_utils.py,sha256=5BY40kXozPKVGOB0eN8jy1P5_GHIzqFJ9FXAu_
 pyglove/core/utils/docstr_utils_test.py,sha256=i33VT6zHXEuIIJ4PPg1bVSfaYSnUsC8yST_NfpT-Uds,4228
 pyglove/core/utils/error_utils.py,sha256=ACIqtq4hsWrV00Gxd1OyeHCI-obGBR6J3H9VI1Y9clM,5780
 pyglove/core/utils/error_utils_test.py,sha256=zwTzmyJupIW8GeF3Z-gnpVNdhdTYwzmO0ClODqbR4bU,4164
-pyglove/core/utils/formatting.py,sha256=qa5XEGRwKEEqEKtyEYZNdsKBxIQFGBTofFW29aQT8hU,14987
-pyglove/core/utils/formatting_test.py,sha256=OQboyCwhgvhw4EcCj1q-O53XG404c0XMK51rCl2_q2M,13533
+pyglove/core/utils/formatting.py,sha256=Wn4d933LQLhuMIfjdRJgpxOThCxBxQrkRBa6Z1-hL_I,15591
+pyglove/core/utils/formatting_test.py,sha256=hhg-nL6DyE5A2QA92ALHK5QtfAYKfPpTbBARF-IT1j0,14241
 pyglove/core/utils/hierarchical.py,sha256=jwB-0FhqOspAymAkvJphRhPTQEsoShmKupCZpU3Vip4,19690
 pyglove/core/utils/hierarchical_test.py,sha256=f382DMJPa_bavJGGQDjuw-hWcafUg5bkQCPX-nbzeiI,21077
 pyglove/core/utils/json_conversion.py,sha256=I0mWn87aAEdaAok9nDvT0ZrmplU40eNmEDUAaNIzZXk,26590
@@ -212,8 +212,8 @@ pyglove/ext/scalars/randoms.py,sha256=LkMIIx7lOq_lvJvVS3BrgWGuWl7Pi91-lA-O8x_gZs
 pyglove/ext/scalars/randoms_test.py,sha256=nEhiqarg8l_5EOucp59CYrpO2uKxS1pe0hmBdZUzRNM,2000
 pyglove/ext/scalars/step_wise.py,sha256=IDw3tuTpv0KVh7AN44W43zqm1-E0HWPUlytWOQC9w3Y,3789
 pyglove/ext/scalars/step_wise_test.py,sha256=TL1vJ19xVx2t5HKuyIzGoogF7N3Rm8YhLE6JF7i0iy8,2540
-pyglove-0.4.5.dev202504220810.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-pyglove-0.4.5.dev202504220810.dist-info/METADATA,sha256=-Sj2NcVurblr6oRtg8MuQGrWR4BZUY3dx_hYoojtNuA,7089
-pyglove-0.4.5.dev202504220810.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-pyglove-0.4.5.dev202504220810.dist-info/top_level.txt,sha256=wITzJSKcj8GZUkbq-MvUQnFadkiuAv_qv5qQMw0fIow,8
-pyglove-0.4.5.dev202504220810.dist-info/RECORD,,
+pyglove-0.4.5.dev202504230810.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+pyglove-0.4.5.dev202504230810.dist-info/METADATA,sha256=R5ML7dzXaFureIQjy76mwR2AHzaVU_ZskS2X4O_uXTM,7089
+pyglove-0.4.5.dev202504230810.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+pyglove-0.4.5.dev202504230810.dist-info/top_level.txt,sha256=wITzJSKcj8GZUkbq-MvUQnFadkiuAv_qv5qQMw0fIow,8
+pyglove-0.4.5.dev202504230810.dist-info/RECORD,,