From: Elrond <elrond+mediagoblin.org@samba-tng.org>
Date: Thu, 24 Jan 2013 09:23:38 +0000 (+0100)
Subject: ProcessingState: Document monkey patching.
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=e38279263704bb99d17f20e66cd4b5ab06a1c459;p=mediagoblin.git

ProcessingState: Document monkey patching.
---

diff --git a/mediagoblin/processing/__init__.py b/mediagoblin/processing/__init__.py
index 738378b8..1760d0b9 100644
--- a/mediagoblin/processing/__init__.py
+++ b/mediagoblin/processing/__init__.py
@@ -81,6 +81,16 @@ class ProcessingState(object):
         self.queued_filename = None
 
         # Monkey patch us onto the entry
+        # This is needed to keep the current calling convention
+        # for processors:
+        #   def process_FOO(entry):
+        #     proc_state = entry.proc_state
+        #     workbench = proc_state.workbench
+        # When all processors use the new stuff, they should be
+        # rewritten:
+        #   def process_FOO(proc_state):
+        #     entry = proc_state.entry
+        #     workbench = proc_state.workbench
         entry.proc_state = self
 
     def set_workbench(self, wb):