Skip to content
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.

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

grass.pygrass: GridModule clean up temporary mapsets when exception occurs #2614

Merged
Merged
Show file tree
Hide file tree
Changes from 5 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
39 changes: 27 additions & 12 deletions python/grass/pygrass/modules/grid/grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
print_function,
unicode_literals,
)
import contextlib
import os
import sys
import multiprocessing as mltp
Expand Down Expand Up @@ -645,8 +646,19 @@ def run(self, patch=True, clean=True):
created by GridModule
:type clean: bool
"""
with contextlib.ExitStack() as stack:
if clean:
stack.callback(self._clean)
self._actual_run(patch=patch)

def _actual_run(self, patch):
"""Run the GRASS command

:param patch: set False if you does not want to patch the results
"""
self.module.flags.overwrite = True
tmszi marked this conversation as resolved.
Show resolved Hide resolved
self.define_mapset_inputs()

if self.debug:
for wrk in self.get_works():
cmd_exe(wrk)
Expand All @@ -657,7 +669,9 @@ def run(self, patch=True, clean=True):
pool.close()
pool.join()
if not result.successful():
raise RuntimeError(_("Execution of subprocesses was not successful"))
raise RuntimeError(
_("Execution of subprocesses was not successful"),
)
tmszi marked this conversation as resolved.
Show resolved Hide resolved

if patch:
if self.move:
Expand Down Expand Up @@ -689,17 +703,18 @@ def run(self, patch=True, clean=True):
fil = open(os.path.join(dirpath, self.out_prefix + par.value), "w+")
fil.close()

if clean:
self.clean_location()
self.rm_tiles()
if self.n_mset:
gisdbase, location = os.path.split(self.move)
self.clean_location(Location(location, gisdbase))
# rm temporary gis_rc
os.remove(self.gisrc_dst)
self.gisrc_dst = None
sht.rmtree(os.path.join(self.move, "PERMANENT"))
sht.rmtree(os.path.join(self.move, self.mset.name))
def _clean(self):
"""Cleanup temporary data"""
self.clean_location()
self.rm_tiles()
if self.n_mset:
gisdbase, location = os.path.split(self.move)
self.clean_location(Location(location, gisdbase))
# rm temporary gis_rc
os.remove(self.gisrc_dst)
self.gisrc_dst = None
sht.rmtree(os.path.join(self.move, "PERMANENT"))
sht.rmtree(os.path.join(self.move, self.mset.name))

def patch(self):
"""Patch the final results."""
Expand Down
14 changes: 10 additions & 4 deletions python/grass/pygrass/modules/tests/grass_pygrass_grid_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,16 +127,22 @@ def run_grid_module():
assert info["min"] > 0


@pytest.mark.parametrize("clean", [True, False])
def test_cleans(tmp_path, clean):
@pytest.mark.parametrize(
"clean, surface",
[
(True, False),
("surface", "non_exist_surface"),
],
)
def test_cleans(tmp_path, clean, surface):
tmszi marked this conversation as resolved.
Show resolved Hide resolved
"""Check that temporary mapsets are cleaned when appropriate"""
location = "test"
mapset_prefix = "abc"
gs.core._create_location_xy(tmp_path, location) # pylint: disable=protected-access
with gs.setup.init(tmp_path / location):
gs.run_command("g.region", s=0, n=50, w=0, e=50, res=1)
surface = "surface"
gs.run_command("r.surf.fractal", output=surface)
if surface == "surface":
gs.run_command("r.surf.fractal", output=surface)

def run_grid_module():
# modules/shortcuts calls get_commands which requires GISBASE.
Expand Down