@task decorator no longer used! Removing that import.
authorChristopher Allan Webber <cwebber@dustycloud.org>
Sat, 13 Aug 2011 17:52:22 +0000 (12:52 -0500)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Sat, 13 Aug 2011 17:52:22 +0000 (12:52 -0500)
mediagoblin/process_media/__init__.py

index 69e4fc45f73283492071b0cb84db7948a9d40bfa..1883691978584ed2411bc769122b72623b11dc3f 100644 (file)
@@ -17,7 +17,7 @@
 import Image
 
 from contextlib import contextmanager
-from celery.task import task, Task
+from celery.task import Task
 from celery import registry
 
 from mediagoblin.db.util import ObjectId
@@ -86,6 +86,18 @@ process_media = registry.tasks[ProcessMedia.name]
 
 
 def mark_entry_failed(entry_id, exc):
+    """
+    Mark a media entry as having failed in its conversion.
+
+    Uses the exception that was raised to mark more information.  If the
+    exception is a derivative of BaseProcessingFail then we can store extra
+    information that can be useful for users telling them why their media failed
+    to process.
+
+    Args:
+     - entry_id: The id of the media entry
+
+    """
     # Was this a BaseProcessingFail?  In other words, was this a
     # type of error that we know how to handle?
     if isinstance(exc, BaseProcessingFail):