Skip to content

Create a session directory with suffix "-1", "-2", etc if it already exists #1818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
valeriupredoi merged 2 commits into from
Nov 22, 2022
Merged

Create a session directory with suffix "-1", "-2", etc if it already exists #1818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
301d1e3
Create a session directory with suffix "-1", "-2", etc if it exists
bouweandela Nov 21, 2022
d91ab50
Add another test
bouweandela Nov 21, 2022
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
25 changes: 20 additions & 5 deletions esmvalcore/_main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,13 +392,28 @@ def run(self,

self._run(recipe, session)

@staticmethod
def _create_session_dir(session):
"""Create `session.session_dir` or an alternative if it exists."""
from .exceptions import RecipeError

session_dir = session.session_dir
for suffix in range(1, 1000):
try:
session_dir.mkdir(parents=True)
except FileExistsError:
session_dir = Path(f"{session.session_dir}-{suffix}")
else:
session.session_name = session_dir.name
return

raise RecipeError(
f"Output directory '{session.session_dir}' already exists and"
" unable to find alternative, aborting to prevent data loss.")

def _run(self, recipe: Path, session) -> None:
"""Run `recipe` using `session`."""
# Create run dir
if session.session_dir.exists():
print(f"ERROR: output directory {session.session_dir} already"
" exists, aborting to prevent data loss")
session.session_dir.mkdir(parents=True)
self._create_session_dir(session)
session.run_dir.mkdir()

# configure logging
Expand Down
19 changes: 16 additions & 3 deletions tests/unit/main/test_esmvaltool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import esmvalcore.esgf
from esmvalcore import __version__
from esmvalcore._main import HEADER, ESMValTool
from esmvalcore.exceptions import RecipeError

LOGGER = logging.getLogger(__name__)

Expand Down Expand Up @@ -134,11 +135,23 @@ def test_run(mocker, session, offline):
)


def test_run_fail_session_dir_exists(session):
def test_run_session_dir_exists(session):
program = ESMValTool()
session.session_dir.mkdir(parents=True)
with pytest.raises(FileExistsError):
program._run(Path('/path/to/recipe_test.yml'), session)
session_dir = session.session_dir
program._create_session_dir(session)
assert session.session_name == f"{session_dir.name}-1"


def test_run_session_dir_exists_alternative_fails(mocker, session):
mocker.patch.object(
esmvalcore._main.Path,
'mkdir',
side_effect=FileExistsError,
)
program = ESMValTool()
with pytest.raises(RecipeError):
program._create_session_dir(session)


def test_clean_preproc_dir(session):
Expand Down