pyglove 0.5.0.dev202508250811__py3-none-any.whl → 0.5.0.dev202511300809__py3-none-any.whl

pyglove/core/io/file_system_test.py

@@ -16,6 +16,8 @@ import os
 import pathlib
 import tempfile
 import unittest
+from unittest import mock
+import fsspec
 from pyglove.core.io import file_system
 
 
@@ -82,6 +84,75 @@ class StdFileSystemTest(unittest.TestCase):
     fs.rmdirs(os.path.join(dir_a, 'b/c'))
     self.assertEqual(sorted(fs.listdir(dir_a)), ['file1'])   # pylint: disable=g-generic-assert
 
+  def test_rename(self):
+    tmp_dir = tempfile.mkdtemp()
+    fs = file_system.StdFileSystem()
+
+    _ = fs.mkdirs(os.path.join(tmp_dir, 'a/b'))
+    file_foo = os.path.join(tmp_dir, 'a/foo.txt')
+    file_bar = os.path.join(tmp_dir, 'a/bar.txt')
+
+    with fs.open(file_foo, 'w') as f:
+      f.write('foo')
+    with fs.open(file_bar, 'w') as f:
+      f.write('bar')
+
+    # Rename file to a new name.
+    file_foo_new = os.path.join(tmp_dir, 'a/foo-new.txt')
+    fs.rename(file_foo, file_foo_new)
+    self.assertFalse(fs.exists(file_foo))
+    self.assertTrue(fs.exists(file_foo_new))
+
+    # Rename file to an existing file name.
+    fs.rename(file_foo_new, file_bar)
+    self.assertFalse(fs.exists(file_foo_new))
+    with fs.open(file_bar, 'r') as f:
+      self.assertEqual(f.read(), 'foo')
+
+    # Rename directory to a new name.
+    dir_b = os.path.join(tmp_dir, 'a/b')
+    dir_c = os.path.join(tmp_dir, 'a/c')
+    fs.rename(dir_b, dir_c)
+    self.assertFalse(fs.exists(dir_b))
+    self.assertTrue(fs.exists(dir_c))
+    self.assertTrue(fs.isdir(dir_c))
+
+    # Rename directory to an existing empty directory.
+    dir_d = os.path.join(tmp_dir, 'a/d')
+    fs.mkdirs(dir_d)
+    fs.rename(dir_c, dir_d)
+    self.assertFalse(fs.exists(dir_c))
+    self.assertTrue(fs.exists(dir_d))
+
+    # Rename directory to a non-empty directory.
+    dir_x = os.path.join(tmp_dir, 'x')
+    dir_a = os.path.join(tmp_dir, 'a')
+    fs.mkdirs(os.path.join(dir_x, 'y'))
+    with self.assertRaises(OSError):
+      fs.rename(dir_a, dir_x)
+    self.assertTrue(fs.exists(dir_a))
+    self.assertTrue(fs.exists(os.path.join(dir_x, 'y')))
+
+    # Errors
+    dir_u = os.path.join(tmp_dir, 'u')
+    dir_u_v = os.path.join(dir_u, 'v')
+    file_u_a = os.path.join(dir_u, 'a.txt')
+    fs.mkdirs(dir_u_v)
+    with fs.open(file_u_a, 'w') as f:
+      f.write('a')
+
+    with self.assertRaises((OSError, NotADirectoryError)):
+      fs.rename(dir_u, file_u_a)
+
+    with self.assertRaises(IsADirectoryError):
+      fs.rename(file_u_a, dir_u_v)
+
+    with self.assertRaises(FileNotFoundError):
+      fs.rename(
+          os.path.join(tmp_dir, 'non-existent'),
+          os.path.join(tmp_dir, 'y')
+      )
+
 
 class MemoryFileSystemTest(unittest.TestCase):
 
@@ -180,6 +251,94 @@ class MemoryFileSystemTest(unittest.TestCase):
     fs.rmdirs(os.path.join(dir_a, 'b/c'))
     self.assertEqual(fs.listdir(dir_a), ['file1'])   # pylint: disable=g-generic-assert
 
+  def test_glob(self):
+    fs = file_system.MemoryFileSystem()
+    fs.mkdirs('/mem/a/b/c')
+    with fs.open('/mem/a/foo.txt', 'w') as f:
+      f.write('foo')
+    with fs.open('/mem/a/bar.json', 'w') as f:
+      f.write('bar')
+    with fs.open('/mem/a/b/baz.txt', 'w') as f:
+      f.write('baz')
+
+    self.assertEqual(
+        sorted(fs.glob('/mem/a/*')),
+        ['/mem/a/b', '/mem/a/b/baz.txt', '/mem/a/b/c',
+         '/mem/a/bar.json', '/mem/a/foo.txt'])
+    self.assertEqual(
+        sorted(fs.glob('/mem/a/*.txt')),
+        ['/mem/a/b/baz.txt', '/mem/a/foo.txt'])
+    self.assertEqual(
+        sorted(fs.glob('/mem/a/b/*')),
+        ['/mem/a/b/baz.txt', '/mem/a/b/c'])
+    self.assertEqual(fs.glob('/mem/a/b/*.txt'), ['/mem/a/b/baz.txt'])
+    self.assertEqual(fs.glob('/mem/a/b/c/*'), [])
+    self.assertEqual(fs.glob('/mem/a/???.txt'), ['/mem/a/foo.txt'])
+    self.assertEqual(fs.glob('/mem/a/bar.*'), ['/mem/a/bar.json'])
+    self.assertEqual(
+        sorted(fs.glob('/mem/a/*.*')),
+        ['/mem/a/b/baz.txt', '/mem/a/bar.json', '/mem/a/foo.txt'])
+
+  def test_rename(self):
+    fs = file_system.MemoryFileSystem()
+    fs.mkdirs('/mem/a/b')
+    with fs.open('/mem/a/foo.txt', 'w') as f:
+      f.write('foo')
+    with fs.open('/mem/a/bar.txt', 'w') as f:
+      f.write('bar')
+
+    # Rename file to a new name.
+    fs.rename('/mem/a/foo.txt', '/mem/a/foo-new.txt')
+    self.assertFalse(fs.exists('/mem/a/foo.txt'))
+    self.assertTrue(fs.exists('/mem/a/foo-new.txt'))
+
+    # Rename file to an existing file name.
+    fs.rename('/mem/a/foo-new.txt', '/mem/a/bar.txt')
+    self.assertFalse(fs.exists('/mem/a/foo-new.txt'))
+    with fs.open('/mem/a/bar.txt', 'r') as f:
+      self.assertEqual(f.read(), 'foo')
+
+    # Rename directory to a new name.
+    fs.rename('/mem/a/b', '/mem/a/c')
+    self.assertFalse(fs.exists('/mem/a/b'))
+    self.assertTrue(fs.exists('/mem/a/c'))
+    self.assertTrue(fs.isdir('/mem/a/c'))
+
+    # Rename directory to an existing empty directory.
+    fs.mkdirs('/mem/a/d')
+    fs.rename('/mem/a/c', '/mem/a/d')
+    self.assertFalse(fs.exists('/mem/a/c'))
+    self.assertTrue(fs.exists('/mem/a/d'))
+
+    # Rename directory to a non-empty directory.
+    fs.mkdirs('/mem/x/y')
+    with self.assertRaisesRegex(OSError, "Directory not empty: '/mem/x'"):
+      fs.rename('/mem/a', '/mem/x')
+    self.assertTrue(fs.exists('/mem/a'))
+    self.assertTrue(fs.exists('/mem/x/y'))
+
+    # Errors
+    fs.mkdirs('/mem/u/v')
+    with fs.open('/mem/u/a.txt', 'w') as f:
+      f.write('a')
+
+    with self.assertRaisesRegex(
+        OSError, "Cannot move directory '/mem/u' to a subdirectory of itself"):
+      fs.rename('/mem/u', '/mem/u/v/w')
+
+    with self.assertRaisesRegex(
+        NotADirectoryError,
+        "Cannot rename directory '/mem/u' to non-directory '/mem/u/a.txt'"):
+      fs.rename('/mem/u', '/mem/u/a.txt')
+
+    with self.assertRaisesRegex(
+        IsADirectoryError,
+        "Cannot rename non-directory '/mem/u/a.txt' to directory '/mem/u/v'"):
+      fs.rename('/mem/u/a.txt', '/mem/u/v')
+
+    with self.assertRaises(FileNotFoundError):
+      fs.rename('/mem/non-existent', '/mem/y')
+
 
 class FileIoApiTest(unittest.TestCase):
 
@@ -217,6 +376,14 @@ class FileIoApiTest(unittest.TestCase):
     file_system.rm(file2)
     self.assertFalse(file_system.path_exists(file2))
 
+    # Test glob with standard file system.
+    glob_dir = os.path.join(tempfile.mkdtemp(), 'glob')
+    file_system.mkdirs(os.path.join(glob_dir, 'a/b'))
+    file_system.writefile(os.path.join(glob_dir, 'a/foo.txt'), 'foo')
+    self.assertEqual(
+        sorted(file_system.glob(os.path.join(glob_dir, 'a/*'))),
+        [os.path.join(glob_dir, 'a/b'), os.path.join(glob_dir, 'a/foo.txt')])
+
   def test_memory_filesystem(self):
     file1 = pathlib.Path('/mem/file1')
     with self.assertRaises(FileNotFoundError):
@@ -248,6 +415,130 @@ class FileIoApiTest(unittest.TestCase):
     file_system.rm(file2)
     self.assertFalse(file_system.path_exists(file2))
 
+    # Test glob with memory file system.
+    file_system.mkdirs('/mem/g/a/b')
+    file_system.writefile('/mem/g/a/foo.txt', 'foo')
+    file_system.rename('/mem/g/a/foo.txt', '/mem/g/a/foo2.txt')
+    file_system.writefile('/mem/g/a/b/bar.txt', 'bar')
+    self.assertEqual(
+        sorted(file_system.glob('/mem/g/a/*')),
+        ['/mem/g/a/b', '/mem/g/a/b/bar.txt', '/mem/g/a/foo2.txt'])
+
+
+class FsspecFileSystemTest(unittest.TestCase):
+
+  def setUp(self):
+    super().setUp()
+    self.fs = fsspec.filesystem('memory')
+    self.fs.pipe('memory:///a/b/c', b'abc')
+    self.fs.pipe('memory:///a/b/d', b'abd')
+    self.fs.mkdir('memory:///a/e')
+
+  def tearDown(self):
+    super().tearDown()
+    fsspec.filesystem('memory').rm('/', recursive=True)
+
+  def test_read_file(self):
+    self.assertEqual(file_system.readfile('memory:///a/b/c', mode='rb'), b'abc')
+    with file_system.open('memory:///a/b/d', 'rb') as f:
+      self.assertEqual(f.read(), b'abd')
+
+  def test_fsspec_file_ops(self):
+    file_system.writefile('memory:///f', b'hello\nworld\n', mode='wb')
+    with file_system.open('memory:///f', 'rb') as f:
+      self.assertIsInstance(f, file_system.FsspecFile)
+      self.assertEqual(f.readline(), b'hello\n')
+      self.assertEqual(f.tell(), 6)
+      self.assertEqual(f.seek(8), 8)
+      self.assertEqual(f.read(), b'rld\n')
+      f.flush()
+
+  def test_write_file(self):
+    file_system.writefile('memory:///a/b/e', b'abe', mode='wb')
+    self.assertTrue(self.fs.exists('memory:///a/b/e'))
+    self.assertEqual(self.fs.cat('memory:///a/b/e'), b'abe')
+
+  def test_exists(self):
+    self.assertTrue(file_system.path_exists('memory:///a/b/c'))
+    self.assertFalse(file_system.path_exists('memory:///a/b/nonexist'))
+
+  def test_isdir(self):
+    self.assertTrue(file_system.isdir('memory:///a/b'))
+    self.assertTrue(file_system.isdir('memory:///a/e'))
+    self.assertFalse(file_system.isdir('memory:///a/b/c'))
+
+  def test_listdir(self):
+    self.assertCountEqual(file_system.listdir('memory:///a'), ['b', 'e'])
+    self.assertCountEqual(file_system.listdir('memory:///a/b'), ['c', 'd'])
+
+  def test_glob(self):
+    self.assertCountEqual(
+        file_system.glob('memory:///a/b/*'),
+        ['memory:///a/b/c', 'memory:///a/b/d']
+    )
+
+  def test_mkdir(self):
+    file_system.mkdir('memory:///a/f')
+    self.assertTrue(self.fs.isdir('memory:///a/f'))
+
+  def test_mkdirs(self):
+    file_system.mkdirs('memory:///g/h/i')
+    self.assertTrue(self.fs.isdir('memory:///g/h/i'))
+
+  def test_rm(self):
+    file_system.rm('memory:///a/b/c')
+    self.assertFalse(self.fs.exists('memory:///a/b/c'))
+
+  def test_rename(self):
+    file_system.rename('memory:///a/b/c', 'memory:///a/b/c_new')
+    self.assertFalse(self.fs.exists('memory:///a/b/c'))
+    self.assertTrue(self.fs.exists('memory:///a/b/c_new'))
+    with self.assertRaisesRegex(ValueError, 'Rename across different'):
+      file_system.rename('memory:///a/b/c_new', 'file:///a/b/c_d')
+
+  def test_chmod(self):
+    mock_fs = mock.Mock()
+    mock_fs.chmod = mock.Mock()
+    with mock.patch('fsspec.core.url_to_fs', return_value=(mock_fs, 'path')):
+      file_system.chmod('protocol:///path', 0o777)
+      mock_fs.chmod.assert_called_once_with('path', 0o777)
+
+  def test_rmdir(self):
+    file_system.rmdir('memory:///a/e')
+    self.assertFalse(self.fs.exists('memory:///a/e'))
+
+  def test_rmdirs(self):
+    file_system.mkdirs('memory:///x/y/z')
+    self.assertTrue(file_system.isdir('memory:///x/y/z'))
+    file_system.rmdirs('memory:///x')
+    self.assertFalse(file_system.path_exists('memory:///x'))
+
+  def test_fsspec_uri_catcher(self):
+    with mock.patch.object(
+        file_system.FsspecFileSystem, 'exists', return_value=True
+    ) as mock_fsspec_exists:
+      # We use a protocol that is not registered in
+      # fsspec.available_protocols() to make sure _FsspecUriCatcher is used.
+      self.assertTrue(file_system.path_exists('some-proto://foo'))
+      mock_fsspec_exists.assert_called_once_with('some-proto://foo')
+
+    # For full coverage of _FsspecUriCatcher.get_fs returning StdFileSystem,
+    # we need to test a non-URI path that doesn't match other prefixes.
+    # We mock StdFileSystem.exists to check if it's called.
+    with mock.patch.object(
+        file_system.StdFileSystem, 'exists', return_value=True
+    ) as mock_std_exists:
+      self.assertTrue(file_system.path_exists('/foo/bar/baz'))
+      mock_std_exists.assert_called_once_with('/foo/bar/baz')
+
+    with mock.patch.object(
+        file_system.FsspecFileSystem, 'rename', return_value=None
+    ) as mock_fsspec_rename:
+      file_system.rename('some-proto://foo', 'some-proto://bar')
+      mock_fsspec_rename.assert_called_once_with(
+          'some-proto://foo', 'some-proto://bar'
+      )
+
 
 if __name__ == '__main__':
   unittest.main()

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()