Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions src/cegpy/utilities/_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,18 @@ def generate_colour_run(number, starts, ends) -> list:


def generate_filename_and_mkdir(filename: Union[str, Path]) -> Tuple[Path, str]:
"""Creates a filename."""
if filename is not Path:
"""Create a filename ensuring the directory exists.

If *filename* has no suffix a ``.png`` suffix is appended and the
corresponding filetype returned.
"""

if not isinstance(filename, Path):
filename = Path(filename)

filetype = filename.suffix.strip(".")
if filename.suffix == filetype:
filename.joinpath(".png")
filetype = filename.suffix.lstrip(".")
if not filetype:
filename = filename.with_suffix(".png")
filetype = "png"

filename.parent.mkdir(parents=True, exist_ok=True)
Expand Down
18 changes: 18 additions & 0 deletions src/tests/test_util.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
"""Tests cegpy.utilities"""
from collections import defaultdict
from tempfile import TemporaryDirectory
from pathlib import Path
import unittest
from cegpy.utilities import (
check_list_contains_strings,
check_tuple_contains_strings,
create_sampling_zeros,
generate_filename_and_mkdir,
)


Expand Down Expand Up @@ -55,3 +58,18 @@ def test_check_tuple_contains_strings(self) -> None:
self.assertFalse(check_tuple_contains_strings(("string thing")))
self.assertTrue(check_tuple_contains_strings(("string one", "string two")))
self.assertFalse(check_tuple_contains_strings((1, "2")))

def test_generate_filename_and_mkdir(self) -> None:
"""Ensure filenames are normalised and directories created."""
with TemporaryDirectory() as tmpdir:
path_no_ext = Path(tmpdir) / "out" / "fig"
filename, filetype = generate_filename_and_mkdir(str(path_no_ext))
self.assertTrue(filename.parent.exists()) # directory exists
self.assertEqual(filename.suffix, ".png")
self.assertEqual(filetype, "png")

path_with_ext = Path(tmpdir) / "out2" / "fig.svg"
filename2, filetype2 = generate_filename_and_mkdir(path_with_ext)
self.assertTrue(filename2.parent.exists())
self.assertEqual(filename2.suffix, ".svg")
self.assertEqual(filetype2, "svg")