aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/workbench.py
diff options
context:
space:
mode:
authorJoar Wandborg <git@wandborg.com>2011-06-15 22:18:24 +0200
committerJoar Wandborg <git@wandborg.com>2011-06-15 22:18:24 +0200
commit9e883ed3b223311e3325e41e75dec7ee82875ac2 (patch)
treede5c404187681bf35d7a92e917c54a69e902df91 /mediagoblin/workbench.py
parenta48014d67a5185c645ac876d365b4cb85cbb6b1f (diff)
parent0e9dd2a28669a4d42c4a3828dbd047937acd776c (diff)
downloadmediagoblin-9e883ed3b223311e3325e41e75dec7ee82875ac2.tar.lz
mediagoblin-9e883ed3b223311e3325e41e75dec7ee82875ac2.tar.xz
mediagoblin-9e883ed3b223311e3325e41e75dec7ee82875ac2.zip
Merge branch 'master' of http://git.gitorious.org/mediagoblin/mediagoblin
Diffstat (limited to 'mediagoblin/workbench.py')
-rw-r--r--mediagoblin/workbench.py89
1 files changed, 51 insertions, 38 deletions
diff --git a/mediagoblin/workbench.py b/mediagoblin/workbench.py
index d7252623..f83c4fa0 100644
--- a/mediagoblin/workbench.py
+++ b/mediagoblin/workbench.py
@@ -23,54 +23,34 @@ DEFAULT_WORKBENCH_DIR = os.path.join(
tempfile.gettempdir(), u'mgoblin_workbench')
-# Exception(s)
-# ------------
-
-class WorkbenchOutsideScope(Exception):
- """
- Raised when a workbench is outside a WorkbenchManager scope.
- """
- pass
-
-
# Actual workbench stuff
# ----------------------
-class WorkbenchManager(object):
+class Workbench(object):
"""
- A system for generating and destroying workbenches.
+ Represent the directory for the workbench
- Workbenches are actually just subdirectories of a temporary storage space
- for during the processing stage.
+ WARNING: DO NOT create Workbench objects on your own,
+ let the WorkbenchManager do that for you!
"""
-
- def __init__(self, base_workbench_dir):
- self.base_workbench_dir = os.path.abspath(base_workbench_dir)
- if not os.path.exists(self.base_workbench_dir):
- os.makedirs(self.base_workbench_dir)
-
- def create_workbench(self):
+ def __init__(self, dir):
"""
- Create and return the path to a new workbench (directory).
+ WARNING: DO NOT create Workbench objects on your own,
+ let the WorkbenchManager do that for you!
"""
- return tempfile.mkdtemp(dir=self.base_workbench_dir)
+ self.dir = dir
- def destroy_workbench(self, workbench):
- """
- Destroy this workbench! Deletes the directory and all its contents!
+ def __unicode__(self):
+ return unicode(self.dir)
+ def __str__(self):
+ return str(self.dir)
+ def __repr__(self):
+ return repr(self.dir)
- Makes sure the workbench actually belongs to this manager though.
- """
- # just in case
- workbench = os.path.abspath(workbench)
-
- if not workbench.startswith(self.base_workbench_dir):
- raise WorkbenchOutsideScope(
- "Can't destroy workbench outside the base workbench dir")
-
- shutil.rmtree(workbench)
+ def joinpath(self, *args):
+ return os.path.join(self.dir, *args)
- def localized_file(self, workbench, storage, filepath,
+ def localized_file(self, storage, filepath,
filename_if_copying=None,
keep_extension_if_copying=True):
"""
@@ -126,10 +106,43 @@ class WorkbenchManager(object):
dest_filename = filename_if_copying
full_dest_filename = os.path.join(
- workbench, dest_filename)
+ self.dir, dest_filename)
# copy it over
storage.copy_locally(
filepath, full_dest_filename)
return full_dest_filename
+
+ def destroy_self(self):
+ """
+ Destroy this workbench! Deletes the directory and all its contents!
+
+ WARNING: Does no checks for a sane value in self.dir!
+ """
+ # just in case
+ workbench = os.path.abspath(self.dir)
+
+ shutil.rmtree(workbench)
+
+ del self.dir
+
+
+class WorkbenchManager(object):
+ """
+ A system for generating and destroying workbenches.
+
+ Workbenches are actually just subdirectories of a temporary storage space
+ for during the processing stage.
+ """
+
+ def __init__(self, base_workbench_dir):
+ self.base_workbench_dir = os.path.abspath(base_workbench_dir)
+ if not os.path.exists(self.base_workbench_dir):
+ os.makedirs(self.base_workbench_dir)
+
+ def create_workbench(self):
+ """
+ Create and return the path to a new workbench (directory).
+ """
+ return Workbench(tempfile.mkdtemp(dir=self.base_workbench_dir))