pyglove 0.4.5.dev20240319__py3-none-any.whl → 0.4.5.dev202501132210__py3-none-any.whl

pyglove/core/object_utils/formatting.py

@@ -1,234 +0,0 @@
-# Copyright 2022 The PyGlove 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.
-"""Utilities for formatting objects."""
-
-import enum
-import sys
-from typing import Any, List, Optional, Sequence, Set, Tuple
-from pyglove.core.object_utils import common_traits
-from pyglove.core.object_utils.value_location import KeyPath
-
-
-def kvlist_str(
-    kvlist: List[Tuple[str, Any, Any]],
-    compact: bool = True,
-    verbose: bool = False,
-    root_indent: int = 0) -> str:
-  """Formats a list key/value pairs into a comma delimited string.
-
-  Args:
-    kvlist: List of tuples in format of
-      (key, value, default_value or a tuple of default values)
-    compact: If True, format value in kvlist in compact form.
-    verbose: If True, format value in kvlist in verbose.
-    root_indent: The indent should be applied for values in kvlist if they are
-      multi-line.
-
-  Returns:
-    A formatted string from a list of key/value pairs delimited by comma.
-  """
-  s = []
-  is_first = True
-  for k, v, d in kvlist:
-    if isinstance(d, tuple):
-      include_pair = True
-      for sd in d:
-        if sd == v:
-          include_pair = False
-          break
-    else:
-      include_pair = v != d
-    if include_pair:
-      if not is_first:
-        s.append(', ')
-      if not isinstance(v, str):
-        v = format(v, compact=compact, verbose=verbose, root_indent=root_indent)
-      if k:
-        s.append(f'{k}={v}')
-      else:
-        s.append(str(v))
-      is_first = False
-  return ''.join(s)
-
-
-def quote_if_str(value: Any) -> Any:
-  """Quotes the value if it is a str."""
-  if isinstance(value, str):
-    return repr(value)
-  return value
-
-
-def comma_delimited_str(value_list: Sequence[Any]) -> str:
-  """Gets comma delimited string."""
-  return ', '.join(str(quote_if_str(v)) for v in value_list)
-
-
-def auto_plural(
-    number: int, singular: str, plural: Optional[str] = None) -> str:
-  """Use singular form if number is 1, otherwise use plural form."""
-  if plural is None:
-    plural = singular + 's'
-  return singular if number == 1 else plural
-
-
-def message_on_path(
-    message: str, path: KeyPath) -> str:
-  """Formats a message that is associated with a `KeyPath`."""
-  if path is None:
-    return message
-  return f'{message} (path={path})'
-
-
-class BracketType(enum.IntEnum):
-  """Bracket types used for complex type formatting."""
-  # Round bracket.
-  ROUND = 0
-
-  # Square bracket.
-  SQUARE = 1
-
-  # Curly bracket.
-  CURLY = 2
-
-
-_BRACKET_CHARS = [
-    ('(', ')'),
-    ('[', ']'),
-    ('{', '}'),
-]
-
-
-def bracket_chars(bracket_type: BracketType) -> Tuple[str, str]:
-  """Gets bracket character."""
-  return _BRACKET_CHARS[int(bracket_type)]
-
-
-def format(   # pylint: disable=redefined-builtin
-    value: Any,
-    compact: bool = False,
-    verbose: bool = True,
-    root_indent: int = 0,
-    list_wrap_threshold: int = 80,
-    strip_object_id: bool = False,
-    include_keys: Optional[Set[str]] = None,
-    exclude_keys: Optional[Set[str]] = None,
-    markdown: bool = False,
-    **kwargs,
-) -> str:
-  """Formats a (maybe) hierarchical value with flags.
-
-  Args:
-    value: The value to format.
-    compact: If True, this object will be formatted into a single line.
-    verbose: If True, this object will be formatted with verbosity. Subclasses
-      should define `verbosity` on their own.
-    root_indent: The start indent level for this object if the output is a
-      multi-line string.
-    list_wrap_threshold: A threshold in number of characters for wrapping a list
-      value in a single line.
-    strip_object_id: If True, format object as '<class-name>(...)' other than
-      'object at <address>'.
-    include_keys: A set of keys to include from the top-level dict or object.
-    exclude_keys: A set of keys to exclude from the top-level dict or object.
-      Applicable only when `include_keys` is set to None.
-    markdown: If True, use markdown notion to quote the formatted object.
-    **kwargs: Keyword arguments that will be passed through unto child
-      ``Formattable`` objects.
-
-  Returns:
-    A string representation for `value`.
-  """
-
-  exclude_keys = exclude_keys or set()
-
-  def _indent(text, indent: int) -> str:
-    return ' ' * 2 * indent + text
-
-  def _should_include_key(key: str) -> bool:
-    if include_keys:
-      return key in include_keys
-    return key not in exclude_keys
-
-  def _format_child(v):
-    return format(v, compact=compact, verbose=verbose,
-                  root_indent=root_indent + 1,
-                  list_wrap_threshold=list_wrap_threshold,
-                  strip_object_id=strip_object_id,
-                  **kwargs)
-
-  if isinstance(value, common_traits.Formattable):
-    return value.format(compact=compact,
-                        verbose=verbose,
-                        root_indent=root_indent,
-                        list_wrap_threshold=list_wrap_threshold,
-                        strip_object_id=strip_object_id,
-                        include_keys=include_keys,
-                        exclude_keys=exclude_keys,
-                        **kwargs)
-  elif isinstance(value, (list, tuple)):
-    # Always try compact representation if length is not too long.
-    open_bracket, close_bracket = bracket_chars(
-        BracketType.SQUARE if isinstance(value, list) else BracketType.ROUND)
-    s = [open_bracket]
-    s.append(', '.join([_format_child(elem) for elem in value]))
-    s.append(close_bracket)
-    s = [''.join(s)]
-    if not compact and len(s[-1]) > list_wrap_threshold:
-      s = [f'{open_bracket}\n']
-      s.append(',\n'.join([
-          _indent(_format_child(elem), root_indent + 1)
-          for elem in value
-      ]))
-      s.append('\n')
-      s.append(_indent(close_bracket, root_indent))
-  elif isinstance(value, dict):
-    if compact or not value:
-      s = ['{']
-      s.append(', '.join([
-          f'{k!r}: {_format_child(v)}'
-          for k, v in value.items() if _should_include_key(k)
-      ]))
-      s.append('}')
-    else:
-      s = ['{\n']
-      s.append(',\n'.join([
-          _indent(f'{k!r}: {_format_child(v)}', root_indent + 1)
-          for k, v in value.items() if _should_include_key(k)
-      ]))
-      s.append('\n')
-      s.append(_indent('}', root_indent))
-  else:
-    if isinstance(value, str):
-      s = [repr(value)]
-    else:
-      s = [repr(value) if compact else str(value)]
-      if strip_object_id and 'object at 0x' in s[-1]:
-        s = [f'{value.__class__.__name__}(...)']
-  return maybe_markdown_quote(''.join(s), markdown)
-
-
-def maybe_markdown_quote(s: str, markdown: bool = True) -> str:
-  """Maybe quote the formatted string with markdown."""
-  if not markdown:
-    return s
-  if '\n' not in s:
-    return f'`{s}`'
-  else:
-    return f'```\n{s}\n```'
-
-
-def printv(v: Any, **kwargs):
-  """Prints formatted value."""
-  fs = kwargs.pop('file', sys.stdout)
-  print(format(v, **kwargs), file=fs)

pyglove/core/object_utils/formatting_test.py

@@ -1,223 +0,0 @@
-# Copyright 2022 The PyGlove 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 pyglove.object_utils.formatting."""
-import inspect
-import unittest
-
-from pyglove.core.object_utils import common_traits
-from pyglove.core.object_utils import formatting
-
-
-class StringHelperTest(unittest.TestCase):
-  """Tests for string helper methods in formatting."""
-
-  def test_kvlist_str(self):
-    self.assertEqual(
-        formatting.kvlist_str([
-            ('', 'foo', None),
-            ('a', 1, None),
-            ('b', 'str', (None, 'str')),
-            ('c', True, False),
-        ]), 'foo, a=1, c=True')
-
-  def test_quote_if_str(self):
-    self.assertEqual(formatting.quote_if_str(1), 1)
-    self.assertEqual(formatting.quote_if_str('foo'), '\'foo\'')
-    self.assertEqual(formatting.quote_if_str('foo\'s\na'), '"foo\'s\\na"')
-
-  def test_message_on_path(self):
-    self.assertEqual(formatting.message_on_path('hi.', None), 'hi.')
-    self.assertEqual(
-        formatting.message_on_path('hi.', formatting.KeyPath()),
-        'hi. (path=)')
-
-  def test_comma_delimited_str(self):
-    self.assertEqual(
-        formatting.comma_delimited_str([1, 2, 'abc']), '1, 2, \'abc\'')
-
-  def test_auto_plural(self):
-    self.assertEqual(formatting.auto_plural(2, 'number'), 'numbers')
-    self.assertEqual(formatting.auto_plural(2, 'was', 'were'), 'were')
-
-
-class FormatTest(unittest.TestCase):
-  """Tests for formatting.format."""
-
-  def test_formattable(self):
-
-    class A(common_traits.Formattable):
-
-      def format(self, compact=True, **kwargs):
-        if compact:
-          return 'A()'
-        else:
-          return 'A(...)'
-
-    self.assertEqual(str(A()), 'A(...)')
-    self.assertEqual(repr(A()), 'A()')
-
-  def test_simple_types(self):
-    self.assertEqual(formatting.format(True, compact=True), 'True')
-    self.assertEqual(formatting.format(1, compact=True), '1')
-    self.assertEqual(formatting.format(1.0, compact=True), '1.0')
-    self.assertEqual(formatting.format('foo', compact=True), '\'foo\'')
-    self.assertEqual(
-        formatting.format('foo\'s\na', compact=True), '"foo\'s\\na"')
-
-    # Compact=False has no impact on simple types.
-    self.assertEqual(formatting.format(True, compact=False), 'True')
-    self.assertEqual(formatting.format(1, compact=False), '1')
-    self.assertEqual(formatting.format(1.0, compact=False), '1.0')
-    self.assertEqual(formatting.format('foo', compact=False), '\'foo\'')
-    self.assertEqual(
-        formatting.format('foo\'s\na', compact=False), '"foo\'s\\na"')
-
-    # Verbose has no impact on simple types.
-    self.assertEqual(formatting.format(True, verbose=True), 'True')
-    self.assertEqual(formatting.format(1, verbose=True), '1')
-    self.assertEqual(formatting.format(1.0, verbose=True), '1.0')
-    self.assertEqual(formatting.format('foo', verbose=True), '\'foo\'')
-    self.assertEqual(
-        formatting.format('foo\'s\na', verbose=True), '"foo\'s\\na"')
-
-    # Root indent has no impact on simple types.
-    self.assertEqual(formatting.format(True, root_indent=4), 'True')
-    self.assertEqual(formatting.format(1, root_indent=4), '1')
-    self.assertEqual(formatting.format(1.0, root_indent=4), '1.0')
-    self.assertEqual(formatting.format('foo', root_indent=4), '\'foo\'')
-    self.assertEqual(
-        formatting.format('foo\'s\na', root_indent=4), '"foo\'s\\na"')
-
-  def test_complex_types(self):
-
-    class CustomFormattable(common_traits.Formattable):
-      """Custom formattable."""
-
-      def format(self, custom_param=None, **kwargs):
-        return f'CustomFormattable({custom_param})'
-
-    class A:
-      pass
-
-    self.assertEqual(
-        formatting.format(
-            {
-                'a': CustomFormattable(),
-                'b': {
-                    'c': [1, 2, 3],
-                    'd': ['foo', 'bar\na', 3, 4, 5]
-                }
-            },
-            compact=True,
-            custom_param='foo'),
-        "{'a': CustomFormattable(foo), 'b': {'c': [1, 2, 3], "
-        "'d': ['foo', 'bar\\na', 3, 4, 5]}}")
-
-    self.assertEqual(
-        formatting.format(
-            {
-                'a': A(),
-                'b': {
-                    'c': [1, 2, 3],
-                    'd': ['foo', 'bar\na', 3, 4, 5]
-                }
-            },
-            compact=False,
-            list_wrap_threshold=15,
-            strip_object_id=True),
-        inspect.cleandoc("""{
-          'a': A(...),
-          'b': {
-            'c': [1, 2, 3],
-            'd': [
-              'foo',
-              'bar\\na',
-              3,
-              4,
-              5
-            ]
-          }
-        }"""))
-
-  def test_include_exclude_keys(self):
-    """Test format with excluded keys."""
-
-    class A:
-      pass
-
-    class B(common_traits.Formattable):
-      """Custom formattable."""
-
-      def format(
-          self, custom_param=None,
-          include_keys=None, exclude_keys=None, **kwargs):
-        exclude_keys = exclude_keys or set()
-        kv = dict(a=1, b=2, c=3)
-        def _should_include(k):
-          if include_keys:
-            return k in include_keys
-          return k not in exclude_keys
-        kv_pairs = [(k, v, None) for k, v in kv.items() if _should_include(k)]
-        return f'B({formatting.kvlist_str(kv_pairs, compact=True)})'
-
-    self.assertEqual(
-        formatting.format(B(), compact=False, include_keys=set(['a', 'c'])),
-        'B(a=1, c=3)')
-    self.assertEqual(
-        formatting.format(B(), compact=False, exclude_keys=set(['a', 'c'])),
-        'B(b=2)')
-    self.assertEqual(
-        formatting.format(
-            {
-                'a': A(),
-                'b': B(),
-                'c': {
-                    'd': [1, 2, 3],
-                }
-            },
-            compact=False,
-            list_wrap_threshold=15,
-            strip_object_id=True,
-            # 'a' should be removed, but 'b.a', 'c.d' should be kept as they are
-            # not at the top level.
-            exclude_keys=set(['a', 'd'])),
-        inspect.cleandoc("""{
-          'b': B(a=1, b=2, c=3),
-          'c': {
-            'd': [1, 2, 3]
-          }
-        }"""))
-
-  def test_markdown(self):
-    self.assertEqual(
-        formatting.format([1], compact=True, markdown=True), '`[1]`'
-    )
-    self.assertEqual(
-        formatting.format(
-            [1, 2, 3], list_wrap_threshold=5, compact=False, markdown=True
-        ),
-        inspect.cleandoc("""
-            ```
-            [
-              1,
-              2,
-              3
-            ]
-            ```
-            """),
-    )
-
-
-if __name__ == '__main__':
-  unittest.main()