def test_readme_writes_correct_info_with_no_git_dir(tmp_path):
# Currently unable to test with a real git directory.
logdir = LogDir("My Experiment", tmp_path)
with pytest.warns(UserWarning):
filepath = logdir.readme(date=True,
git_commit=True,
git_path=tmp_path,
info=["random info"])
with filepath.open() as file:
assert file.read() == f"""\
def test_copy(tmp_path):
logdir = LogDir("My Experiment", tmp_path / "logs")
src = tmp_path / "new.txt"
with src.open("w") as file:
file.write("Hello World")
logdir.copy(src, "newdir/new.txt")
full_dest = Path(logdir.logdir / "newdir" / "new.txt")
assert full_dest.is_file()
with full_dest.open("r") as file:
assert file.read() == "Hello World"
def test_nested_file(tmp_path, touch, touch_inter):
logdir = LogDir("My Experiment", tmp_path)
file = logdir.file("newdir/file.txt", touch, touch_inter)
assert Path(file) == (tmp_path / f"{TIME_STR}_my-experiment" / "newdir" /
"file.txt")
if not touch_inter:
assert not Path(file).parent.is_dir() and not Path(file).is_file()
if touch_inter:
if touch:
# Implies the parent dir also exists.
assert Path(file).is_file()
else:
assert Path(file).parent.is_dir() and not Path(file).is_file()
def test_nested_dir(tmp_path, touch, touch_inter):
logdir = LogDir("My Experiment", tmp_path)
dirname = logdir.dir("newdir/mydir", touch, touch_inter)
assert Path(dirname) == (tmp_path / f"{TIME_STR}_my-experiment" / "newdir" /
"mydir")
if not touch_inter:
assert not Path(dirname).parent.is_dir() and not Path(dirname).is_dir()
if touch_inter:
if touch:
# Implies the parent dir also exists.
assert Path(dirname).is_dir()
else:
assert Path(dirname).parent.is_dir() and not Path(dirname).is_dir()
def test_file(tmp_path, touch):
logdir = LogDir("My Experiment", tmp_path)
file = logdir.file("file.txt", touch)
assert Path(file) == (tmp_path / f"{TIME_STR}_my-experiment" / "file.txt")
assert Path(file).is_file() if touch else (not Path(file).is_file())
def test_reuses_existing_dir(tmp_path):
custom_path = tmp_path / "customdir"
custom_path.mkdir()
logdir = LogDir("My Experiment", custom_dir=custom_path)
assert custom_path.is_dir()
assert logdir.logdir == custom_path
def test_creates_nested_custom_dir_on_init(tmp_path):
LogDir("My Experiment", custom_dir=tmp_path / "abcde" / "customdir")
custom_path = tmp_path / "abcde" / "customdir"
assert custom_path.is_dir()
def test_creates_nested_dir_on_init(tmp_path):
LogDir("My Experiment", tmp_path / "logs")
expected_path = tmp_path / "logs" / f"{TIME_STR}_my-experiment"
assert expected_path.is_dir()
def test_properties_correct(tmp_path):
logdir = LogDir("My Experiment", tmp_path)
assert logdir.name == "My Experiment"
assert logdir.datetime == datetime.datetime.fromisoformat(TIME)
assert logdir.logdir == tmp_path / f"{TIME_STR}_my-experiment"
def test_save_data_goes_to_pkl_with_unknown_ext(data, tmp_path):
logdir = LogDir("My Experiment", tmp_path)
with pytest.warns(UserWarning):
filepath = logdir.save_data(data, "data.foo")
with filepath.open("rb") as file:
assert pickle.load(file) == data
def test_save_data(ext, load, mode, data, tmp_path):
logdir = LogDir("My Experiment", tmp_path)
filepath = logdir.save_data(data, f"data.{ext}")
with filepath.open(mode) as file:
assert load(file) == data
def test_dir(tmp_path, touch):
logdir = LogDir("My Experiment", tmp_path)
dirname = logdir.dir("mydir", touch)
assert Path(dirname) == (tmp_path / f"{TIME_STR}_my-experiment" / "mydir")
assert Path(dirname).is_dir() if touch else (not Path(dirname).is_dir())