pyglove 0.5.0.dev202509240810__py3-none-any.whl → 0.5.0.dev202509250810__py3-none-any.whl

pyglove/core/logging.py

@@ -17,9 +17,11 @@ This module allows PyGlove to use external created logger for logging PyGlove
 events without introducing library dependencies in PyGlove.
 """
 
+import contextlib
 import inspect
 import logging
-from typing import Any, Callable, List, Union
+import sys
+from typing import Any, Callable, Iterator, List, Union
 
 
 _DEFAULT_LOGGER = logging.getLogger()
@@ -117,3 +119,45 @@ def critical(msg: str, *args, **kwargs) -> None:
     **kwargs: Keyword arguments for the logger.
   """
   _DEFAULT_LOGGER.critical(msg, *args, **kwargs)
+
+
+def use_stream(
+    stream: Any,
+    level: int = logging.INFO,
+    name: str = 'custom',
+    fmt: str = '{levelname:8} | {asctime} | {message}',
+    datefmt: str = '%Y-%m-%d %H:%M:%S') -> logging.Logger:
+  """Use stdout for logging."""
+  logger = logging.getLogger(name)
+  logger.setLevel(level)
+  stdout_handler = logging.StreamHandler(stream=stream)
+  stdout_handler.setLevel(level)
+  stdout_handler.setFormatter(
+      logging.Formatter(fmt=fmt, datefmt=datefmt, style='{'))
+  logger.addHandler(stdout_handler)
+  set_logger(logger)
+  return logger
+
+
+def use_stdout(
+    level: int = logging.INFO,
+    fmt: str = '{levelname:8} | {asctime} | {message}',
+    datefmt: str = '%Y-%m-%d %H:%M:%S') -> logging.Logger:
+  """Use stdout for logging."""
+  return use_stream(sys.stdout, level, 'stdout', fmt, datefmt)
+
+
+@contextlib.contextmanager
+def redirect_stream(
+    stream: Any,
+    level: int = logging.INFO,
+    name: str = 'custom',
+    fmt: str = '{levelname:8} | {asctime} | {message}',
+    datefmt: str = '%Y-%m-%d %H:%M:%S') -> Iterator[logging.Logger]:
+  """Redirect the stream to the given logger."""
+  previous_logger = get_logger()
+  try:
+    logger = use_stream(stream, level, name, fmt, datefmt)
+    yield logger
+  finally:
+    set_logger(previous_logger)

pyglove/core/logging_test.py

@@ -21,15 +21,9 @@ class LoggingTest(unittest.TestCase):
   """Tests for pg.logging."""
 
   def testLogging(self):
-    string_io = io.StringIO()
-    logger = logging.getLogger('logger1')
-    logger.setLevel(logging.INFO)
-    console_handler = logging.StreamHandler(stream=string_io)
-    console_handler.setLevel(logging.INFO)
-    logger.addHandler(console_handler)
-
     self.assertIs(pg_logging.get_logger(), logging.getLogger())
-    pg_logging.set_logger(logger)
+    string_io = io.StringIO()
+    logger = pg_logging.use_stream(string_io, name='logger1', fmt='')
     self.assertIs(pg_logging.get_logger(), logger)
 
     pg_logging.debug('x=%s', 1)
@@ -46,19 +40,16 @@ class LoggingTest(unittest.TestCase):
     ]) + '\n')
 
     string_io = io.StringIO()
-    logger = logging.getLogger('logger2')
-    logger.setLevel(logging.DEBUG)
-    console_handler = logging.StreamHandler(stream=string_io)
-    console_handler.setLevel(logging.DEBUG)
-    logger.addHandler(console_handler)
-
-    pg_logging.set_logger(logger)
-
-    pg_logging.debug('x=%s', 6)
-    self.assertEqual(string_io.getvalue(), '\n'.join([
-        'x=6',
-    ]) + '\n')
-
+    with pg_logging.redirect_stream(
+        string_io, level=logging.DEBUG, name='logger2', fmt=''
+    ):
+      pg_logging.debug('x=%s', 6)
+      self.assertEqual(string_io.getvalue(), '\n'.join([
+          'x=6',
+      ]) + '\n')
+
+    pg_logging.use_stdout()
+    pg_logging.info('y=%s', 7)
 
 if __name__ == '__main__':
   unittest.main()

{pyglove-0.5.0.dev202509240810.dist-info → pyglove-0.5.0.dev202509250810.dist-info}/METADATA

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

{pyglove-0.5.0.dev202509240810.dist-info → pyglove-0.5.0.dev202509250810.dist-info}/RECORD

@@ -1,7 +1,7 @@
 pyglove/__init__.py,sha256=LP1HNk_VVWMHaakX3HZ0NeZ2c4lq2uJaRbalvT8haOg,1352
 pyglove/core/__init__.py,sha256=H4Yah3bYPrEqvuwRvhbA1MbQn7W6l2j5mmXkeAUNI30,9700
-pyglove/core/logging.py,sha256=pD5A6K8TOWoQdYZ1IgGHHd_vIcqtcWQ51Eep5Hswfwc,3305
-pyglove/core/logging_test.py,sha256=3z_c6wnxbqDbwUmSOAZzeDPXvzoweYL5QHUQVMJ5Xgo,1917
+pyglove/core/logging.py,sha256=zTNLGnWrl6kkjjEjTphQMeNf9FfqFtl1G9VCh2LhnHg,4614
+pyglove/core/logging_test.py,sha256=ioDbmf4S6xQXeyGWihvk6292wfYdldBw_TK1WXvIq5k,1648
 pyglove/core/coding/__init__.py,sha256=tuHIg19ZchtkOQbdFVTVLkUpBa5f1eo66XtnKw3lcIU,1645
 pyglove/core/coding/errors.py,sha256=aP3Y4amBzOKdlb5JnESJ3kdoijQXbiBiPDMeA88LNrk,3310
 pyglove/core/coding/errors_test.py,sha256=fwOR8vLiRvLadubsccyE19hLHj-kThlCQt88qmUYk9M,2311
@@ -216,8 +216,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.5.0.dev202509240810.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-pyglove-0.5.0.dev202509240810.dist-info/METADATA,sha256=BoC21e6y183t2rlQ3PerySZgxJvAHMTA8EMk00rxVHE,7089
-pyglove-0.5.0.dev202509240810.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyglove-0.5.0.dev202509240810.dist-info/top_level.txt,sha256=wITzJSKcj8GZUkbq-MvUQnFadkiuAv_qv5qQMw0fIow,8
-pyglove-0.5.0.dev202509240810.dist-info/RECORD,,
+pyglove-0.5.0.dev202509250810.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+pyglove-0.5.0.dev202509250810.dist-info/METADATA,sha256=-A3u9ImrpxGGoXwbhEuP4hb5beUNkO9iFaxVQ-tju1Y,7089
+pyglove-0.5.0.dev202509250810.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyglove-0.5.0.dev202509250810.dist-info/top_level.txt,sha256=wITzJSKcj8GZUkbq-MvUQnFadkiuAv_qv5qQMw0fIow,8
+pyglove-0.5.0.dev202509250810.dist-info/RECORD,,