aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Spaeth <Sebastian@SSpaeth.de>2012-12-12 14:08:38 +0100
committerSebastian Spaeth <Sebastian@SSpaeth.de>2013-01-16 20:19:25 +0100
commitbd6fe9774693a241e99138c987f71b80d968bdc3 (patch)
tree1e17b4ca9435803e0ecafc695f8fe7c7b6fe692a
parent45ab3e07ef26199572207f5d826e6d912eb5b336 (diff)
downloadmediagoblin-bd6fe9774693a241e99138c987f71b80d968bdc3.tar.lz
mediagoblin-bd6fe9774693a241e99138c987f71b80d968bdc3.tar.xz
mediagoblin-bd6fe9774693a241e99138c987f71b80d968bdc3.zip
Shorten Workbench(Manager) method names
1) destroy_self() is a horrible function name, make it "destroy". workbench.destroy() is descriptive enough. 2) WorkbenchManager.create_workbench() -> WorkbenchManager.create() We use the pattern "with workbench_manager.create() as workbench:" No need to mention workbenches three times in a row... Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
-rw-r--r--mediagoblin/decorators.py2
-rw-r--r--mediagoblin/tests/test_workbench.py13
-rw-r--r--mediagoblin/workbench.py8
3 files changed, 12 insertions, 11 deletions
diff --git a/mediagoblin/decorators.py b/mediagoblin/decorators.py
index 3655d758..804fab7e 100644
--- a/mediagoblin/decorators.py
+++ b/mediagoblin/decorators.py
@@ -230,7 +230,7 @@ def get_workbench(func):
@wraps(func)
def new_func(*args, **kwargs):
- with mgg.workbench_manager.create_workbench() as workbench:
+ with mgg.workbench_manager.create() as workbench:
return func(*args, workbench=workbench, **kwargs)
return new_func
diff --git a/mediagoblin/tests/test_workbench.py b/mediagoblin/tests/test_workbench.py
index 04a74653..46fc39e4 100644
--- a/mediagoblin/tests/test_workbench.py
+++ b/mediagoblin/tests/test_workbench.py
@@ -28,19 +28,20 @@ class TestWorkbench(object):
os.path.join(tempfile.gettempdir(), u'mgoblin_workbench_testing'))
def test_create_workbench(self):
- workbench = self.workbench_manager.create_workbench()
+ workbench = self.workbench_manager.create()
assert os.path.isdir(workbench.dir)
assert workbench.dir.startswith(self.workbench_manager.base_workbench_dir)
+ workbench.destroy()
def test_joinpath(self):
- this_workbench = self.workbench_manager.create_workbench()
+ this_workbench = self.workbench_manager.create()
tmpname = this_workbench.joinpath('temp.txt')
assert tmpname == os.path.join(this_workbench.dir, 'temp.txt')
- this_workbench.destroy_self()
+ this_workbench.destroy()
def test_destroy_workbench(self):
# kill a workbench
- this_workbench = self.workbench_manager.create_workbench()
+ this_workbench = self.workbench_manager.create()
tmpfile_name = this_workbench.joinpath('temp.txt')
tmpfile = file(tmpfile_name, 'w')
with tmpfile:
@@ -49,13 +50,13 @@ class TestWorkbench(object):
assert os.path.exists(tmpfile_name)
wb_dir = this_workbench.dir
- this_workbench.destroy_self()
+ this_workbench.destroy()
assert not os.path.exists(tmpfile_name)
assert not os.path.exists(wb_dir)
def test_localized_file(self):
tmpdir, this_storage = get_tmp_filestorage()
- this_workbench = self.workbench_manager.create_workbench()
+ this_workbench = self.workbench_manager.create()
# Write a brand new file
filepath = ['dir1', 'dir2', 'ourfile.txt']
diff --git a/mediagoblin/workbench.py b/mediagoblin/workbench.py
index bf18b6cd..0d4db52b 100644
--- a/mediagoblin/workbench.py
+++ b/mediagoblin/workbench.py
@@ -119,7 +119,7 @@ class Workbench(object):
return full_dest_filename
- def destroy_self(self):
+ def destroy(self):
"""
Destroy this workbench! Deletes the directory and all its contents!
@@ -136,7 +136,7 @@ class Workbench(object):
def __exit__(self, *args):
"""Clean up context manager, aka ourselves, deleting the workbench"""
- self.destroy_self()
+ self.destroy()
class WorkbenchManager(object):
@@ -147,7 +147,7 @@ class WorkbenchManager(object):
storage space for during the processing stage. The preferred way to
create them is to use:
- with workbenchmger.create_workbench as workbench:
+ with workbenchmger.create() as workbench:
do stuff...
This will automatically clean up all temporary directories even in
@@ -161,7 +161,7 @@ class WorkbenchManager(object):
if not os.path.exists(self.base_workbench_dir):
os.makedirs(self.base_workbench_dir)
- def create_workbench(self):
+ def create(self):
"""
Create and return the path to a new workbench (directory).
"""