Changeset 7819 for main/waeup.kofa/trunk/src/waeup/kofa/image

Timestamp:

8 Mar 2012, 22:28:46 (13 years ago)

Author:

Henrik Bettermann

Message:

KOFA -> Kofa

Location:

main/waeup.kofa/trunk/src/waeup/kofa/image

Files:

• README.txt (modified) (10 diffs)
• __init__.py (modified) (1 diff)
• browser/tests/image.txt (modified) (6 diffs)
• browser/widget.py (modified) (3 diffs)
• image.py (modified) (3 diffs)
• interfaces.py (modified) (1 diff)
• schema.py (modified) (2 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/image/README.txt

@@ -2 +2 @@
 ========================================
 
-The image file widget is built on top of the :class:`KOFAImageFile` object::
-
-  >>> from waeup.kofa.image import KOFAImageFile
-  >>> file = KOFAImageFile('foo.jpg', 'mydata')
+The image file widget is built on top of the :class:`KofaImageFile` object::
+
+  >>> from waeup.kofa.image import KofaImageFile
+  >>> file = KofaImageFile('foo.jpg', 'mydata')
   >>> file.filename
   'foo.jpg'
@@ -16 +16 @@
   'mydata'
 
-We can also create KOFAImageFile objects from file-like objects::
+We can also create KofaImageFile objects from file-like objects::
 
   >>> from StringIO import StringIO
@@ -36 +36 @@
 ----------------
 
-The KOFAImageFile object normally stores the file data using ZODB
+The KofaImageFile object normally stores the file data using ZODB
 persistence. Files can however also be stored by tramline.  If
 tramline is installed in Apache, the Tramline takes care of generating
@@ -73 +73 @@
 just '1') will now be created::
 
-  >>> file = KOFAImageFile('foo.jpg', '1')
+  >>> file = KofaImageFile('foo.jpg', '1')
 
 The data is now '1', referring to the real file::
@@ -102 +102 @@
 We expect the same behavior as when tramline is not installed::
 
-  >>> file = KOFAImageFile('foo.jpg', 'data')
+  >>> file = KofaImageFile('foo.jpg', 'data')
   >>> f = file.file
   >>> f.read()
@@ -141 +141 @@
   Traceback (most recent call last):
   ...
-  WrongType: ('asd', <class 'waeup.kofa.image.image.KOFAImageFile'>, 'foo')
+  WrongType: ('asd', <class 'waeup.kofa.image.image.KofaImageFile'>, 'foo')
 
 which means: `ImageFile` fields should better contain
-:class:`KOFAImageFile` instances.
-
-We can store normal :class:`KOFAImageFile` instances:
-
-  >>> field.validate(KOFAImageFile('bar.jpg', 'data')) is None
+:class:`KofaImageFile` instances.
+
+We can store normal :class:`KofaImageFile` instances:
+
+  >>> field.validate(KofaImageFile('bar.jpg', 'data')) is None
   True
 
@@ -173 +173 @@
 
   >>> field.validate(
-  ...     KOFAImageFile('bar.jpg', '123456789012')) is None
-  True
-
-  >>> field.validate(
-  ...     KOFAImageFile('bar.jpg', '12345')) is None
+  ...     KofaImageFile('bar.jpg', '123456789012')) is None
+  True
+
+  >>> field.validate(
+  ...     KofaImageFile('bar.jpg', '12345')) is None
   True
 
@@ -183 +183 @@
 
   >>> field.validate(
-  ...     KOFAImageFile('bar.jpg', '1234567890123'))
+  ...     KofaImageFile('bar.jpg', '1234567890123'))
   Traceback (most recent call last):
   ...
@@ -189 +189 @@
 
   >>> field.validate(
-  ...     KOFAImageFile('bar.jpg', '1234'))
+  ...     KofaImageFile('bar.jpg', '1234'))
   Traceback (most recent call last):
   ...
@@ -198 +198 @@
 ----------------------------
 
-KOFAImageFile does not reproduce the broken unequal comparison from
+KofaImageFile does not reproduce the broken unequal comparison from
 its base:
 
-  >>> f1 = KOFAImageFile('bar.jpg', '123456789')
-  >>> f2 = KOFAImageFile('bar.jpg', '123456789')
-  >>> f3 = KOFAImageFile('baz.jpg', '1234')
+  >>> f1 = KofaImageFile('bar.jpg', '123456789')
+  >>> f2 = KofaImageFile('bar.jpg', '123456789')
+  >>> f3 = KofaImageFile('baz.jpg', '1234')
   >>> f1 == f2
   True

main/waeup.kofa/trunk/src/waeup/kofa/image/__init__.py

@@ -3 +3 @@
 Includings schemas, widgets and the content components.
 """
-from waeup.kofa.image.image import KOFAImageFile, createKOFAImageFile
+from waeup.kofa.image.image import KofaImageFile, createKofaImageFile
 
 __all__ = [
-    "KOFAImageFile",
-    "createKOFAImageFile",
+    "KofaImageFile",
+    "createKofaImageFile",
     ]

main/waeup.kofa/trunk/src/waeup/kofa/image/browser/tests/image.txt

@@ -12 +12 @@
 
   >>> import os
-  >>> from waeup.kofa.image import KOFAImageFile
+  >>> from waeup.kofa.image import KofaImageFile
   >>> testimage = os.path.join(os.path.dirname(__file__), 'sample.jpg')
   >>> testimage2 = os.path.join(os.path.dirname(__file__), 'sample2.jpg')
-  >>> some_file = KOFAImageFile('foo.jpg', open(testimage, 'rb').read())
+  >>> some_file = KofaImageFile('foo.jpg', open(testimage, 'rb').read())
   >>> some_file.filename
   'foo.jpg'
@@ -166 +166 @@
 prepare some new file:
 
-  >>> another_file = KOFAImageFile('bar.txt', 'bar contents')
+  >>> another_file = KofaImageFile('bar.txt', 'bar contents')
 
 We happen to know, due to the implementation of
@@ -200 +200 @@
 ---------------------------
 
-As :class:`waeup.kofa.image.KOFAImageFile` objects support storing
+As :class:`waeup.kofa.image.KofaImageFile` objects support storing
 image data by using external 'storages', also our widgets should do
 so.
@@ -220 +220 @@
   ...         contents = f.read()
   ...         id_string = hashlib.md5(contents).hexdigest()
-  ...         result = KOFAImageFile(filename, id_string)
+  ...         result = KofaImageFile(filename, id_string)
   ...         self.storage[id_string] = contents
   ...         return result
@@ -260 +260 @@
 We now want to simulate, that the field contains already data,
 identified by some `file_id`. To do so, we first store the data in our
-file retrieval and then create a KOFAImageFile object with that
+file retrieval and then create a KofaImageFile object with that
 file_id stored:
 
-  >>> from waeup.kofa.image import createKOFAImageFile
-  >>> image = createKOFAImageFile(
+  >>> from waeup.kofa.image import createKofaImageFile
+  >>> image = createKofaImageFile(
   ...     'sample.jpg', open(testimage, 'rb'))
   >>> file_id = image.data
@@ -274 +274 @@
   '9feac4265077922000aa8b88748e25be'
 
-The new file was stored by our utility, as createKOFAImageFile looks
+The new file was stored by our utility, as createKofaImageFile looks
 up IFileRetrieval utilities and uses them:
 

main/waeup.kofa/trunk/src/waeup/kofa/image/browser/widget.py

@@ -19 +19 @@
 """
 import os
-from waeup.kofa.image import KOFAImageFile
+from waeup.kofa.image import KofaImageFile
 from hurry.file.browser.widget import (
     EncodingFileWidget, DownloadWidget, FakeFieldStorage)
@@ -62 +62 @@
                 seek(0)
                 return retrieval.createFile(input.filename, input)
-            return KOFAImageFile(input.filename, data)
+            return KofaImageFile(input.filename, data)
         else:
             return self.context.missing_value
@@ -143 +143 @@
         data = file_id.decode('base64')
         filename, filedata = data.split('\n', 1)
-        return KOFAImageFile(filename, filedata)
+        return KofaImageFile(filename, filedata)
 
 class ThumbnailWidget(DownloadWidget):

main/waeup.kofa/trunk/src/waeup/kofa/image/image.py

@@ -23 +23 @@
 from zope.component import getUtility
 from zope.interface import implements
-from waeup.kofa.image.interfaces import IKOFAImageFile
+from waeup.kofa.image.interfaces import IKofaImageFile
 
-class KOFAImageFile(HurryFile):
+class KofaImageFile(HurryFile):
     """A file prepared for storing image files.
 
@@ -32 +32 @@
     regular hurry files.
 
-    To create a :class:`KOFAImageFile` you should use
-    :func:`createKOFAImageFile`.
+    To create a :class:`KofaImageFile` you should use
+    :func:`createKofaImageFile`.
     """
-    implements(IKOFAImageFile)
+    implements(IKofaImageFile)
 
     def __ne__(self, other):
@@ -45 +45 @@
             return True
 
-def createKOFAImageFile(filename, f):
+def createKofaImageFile(filename, f):
     retrieval = getUtility(IFileRetrieval)
     return retrieval.createFile(filename, f)

main/waeup.kofa/trunk/src/waeup/kofa/image/interfaces.py

@@ -24 +24 @@
     """
 
-class IKOFAImageFile(IHurryFile):
+class IKofaImageFile(IHurryFile):
     """Image file.
     """

main/waeup.kofa/trunk/src/waeup/kofa/image/schema.py

@@ -23 +23 @@
 from hurry.file.schema import File
 from waeup.kofa.image.interfaces import IImageFile
-from waeup.kofa.image.image import KOFAImageFile
+from waeup.kofa.image.image import KofaImageFile
 
 class MinMaxSize(object):
@@ -82 +82 @@
     implements(IImageFile)
 
-    _type = KOFAImageFile
+    _type = KofaImageFile