File types tand fields for images, files and blob files with filenames

Navigation

Verified details

These details have been verified by PyPI
Owner
organization icon Plone
Maintainers
Avatar for davisagli from gravatar.com davisagli Avatar for esteele from gravatar.com esteele Avatar for laurencerowe from gravatar.com laurencerowe Avatar for miohtama from gravatar.com miohtama Avatar for optilude from gravatar.com optilude Avatar for timo from gravatar.com timo

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

Introduction

This package contains fields and wrapper objects for storing:

  • A file with a filename

  • An image with a filename

  • A file stored in a ZODB blob, with a filename

  • An image stored in a ZODB blob, with a filename

See the usage.txt doctest for more details. Changelog =========

1.0a1 - 2009-04-17

  • Initial release

Usage

This demonstrates how to use the package.

Test setup

We must first load the package’s ZCML plus some dependencies. In your own code, only the last <include /> should be necessary.

>>> configuration = """\
... <configure
...      xmlns="http://namespaces.zope.org/zope"
...      i18n_domain="plone.namedfile.tests">
...
...     <include package="zope.security" file="meta.zcml" />
...     <include package="zope.component" file="meta.zcml" />
...     <include package="zope.app.component" file="meta.zcml" />
...     <include package="zope.app.publisher" file="meta.zcml" />
...
...     <permission id="zope2.View" title="View" />
...
...     <include package="plone.namedfile" />
...
... </configure>
... """

>>> from StringIO import StringIO
>>> from zope.configuration import xmlconfig
>>> xmlconfig.xmlconfig(StringIO(configuration))

Schema fields

The following schema fields can be used to describe file data.

>>> from zope.interface import Interface
>>> from plone.namedfile import field

>>> class IFileContainer(Interface):
...     simple = field.NamedFile(title=u"Named file")
...     image = field.NamedImage(title=u"Named image file")
...     blob = field.NamedBlobFile(title=u"Named blob file")
...     blobimage = field.NamedBlobImage(title=u"Named blob image file")

These store data with the following types:

>>> from zope.interface import implements
>>> from plone import namedfile

>>> class FileContainer(object):
...     implements(IFileContainer)
...     def __init__(self):
...         self.simple = namedfile.NamedFile()
...         self.image = namedfile.NamedImage()
...         self.blob = namedfile.NamedBlobFile()
...         self.blobimage = namedfile.NamedBlobImage()

File data and content type

Let’s now show how to get and set file data.

The FileContainer class creates empty objects to start with.

>>> container = FileContainer()

>>> container.simple.data
''
>>> container.simple.contentType
''
>>> container.simple.filename is None
True

>>> container.image.data
''
>>> container.image.contentType
''
>>> container.image.filename is None
True

>>> container.blob.data
''
>>> container.blob.contentType
''
>>> container.blob.filename is None
True

>>> container.blobimage.data
''
>>> container.blobimage.contentType
''
>>> container.blobimage.filename is None
True

Let’s now set some actual data in these files. Notice how the constructor will attempt to guess the filename from the file extension.

>>> container.simple = namedfile.NamedFile('dummy test data', filename="test.txt")
>>> container.simple.data
'dummy test data'
>>> container.simple.contentType
'text/plain'
>>> container.simple.filename
'test.txt'

>>> container.blob = namedfile.NamedBlobFile('dummy test data', filename="test.txt")
>>> container.blob.data
'dummy test data'
>>> container.blob.contentType
'text/plain'
>>> container.blob.filename
'test.txt'

Let’s also try to read a GIF, courtesy of the zope.app.file tests:

>>> zptlogo = (
...     'GIF89a\x10\x00\x10\x00\xd5\x00\x00\xff\xff\xff\xff\xff\xfe\xfc\xfd\xfd'
...     '\xfa\xfb\xfc\xf7\xf9\xfa\xf5\xf8\xf9\xf3\xf6\xf8\xf2\xf5\xf7\xf0\xf4\xf6'
...     '\xeb\xf1\xf3\xe5\xed\xef\xde\xe8\xeb\xdc\xe6\xea\xd9\xe4\xe8\xd7\xe2\xe6'
...     '\xd2\xdf\xe3\xd0\xdd\xe3\xcd\xdc\xe1\xcb\xda\xdf\xc9\xd9\xdf\xc8\xd8\xdd'
...     '\xc6\xd7\xdc\xc4\xd6\xdc\xc3\xd4\xda\xc2\xd3\xd9\xc1\xd3\xd9\xc0\xd2\xd9'
...     '\xbd\xd1\xd8\xbd\xd0\xd7\xbc\xcf\xd7\xbb\xcf\xd6\xbb\xce\xd5\xb9\xcd\xd4'
...     '\xb6\xcc\xd4\xb6\xcb\xd3\xb5\xcb\xd2\xb4\xca\xd1\xb2\xc8\xd0\xb1\xc7\xd0'
...     '\xb0\xc7\xcf\xaf\xc6\xce\xae\xc4\xce\xad\xc4\xcd\xab\xc3\xcc\xa9\xc2\xcb'
...     '\xa8\xc1\xca\xa6\xc0\xc9\xa4\xbe\xc8\xa2\xbd\xc7\xa0\xbb\xc5\x9e\xba\xc4'
...     '\x9b\xbf\xcc\x98\xb6\xc1\x8d\xae\xbaFgs\x00\x00\x00\x00\x00\x00\x00\x00'
...     '\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
...     '\x00,\x00\x00\x00\x00\x10\x00\x10\x00\x00\x06z@\x80pH,\x12k\xc8$\xd2f\x04'
...     '\xd4\x84\x01\x01\xe1\xf0d\x16\x9f\x80A\x01\x91\xc0ZmL\xb0\xcd\x00V\xd4'
...     '\xc4a\x87z\xed\xb0-\x1a\xb3\xb8\x95\xbdf8\x1e\x11\xca,MoC$\x15\x18{'
...     '\x006}m\x13\x16\x1a\x1f\x83\x85}6\x17\x1b $\x83\x00\x86\x19\x1d!%)\x8c'
...     '\x866#\'+.\x8ca`\x1c`(,/1\x94B5\x19\x1e"&*-024\xacNq\xba\xbb\xb8h\xbeb'
...     '\x00A\x00;'
...     )

>>> container.image = namedfile.NamedImage(zptlogo, filename="zpt.gif")
>>> container.image.data == zptlogo
True
>>> container.image.contentType
'image/gif'
>>> container.image.filename
'zpt.gif'

>>> container.blobimage = namedfile.NamedBlobImage(zptlogo, filename="zpt.gif")
>>> container.blobimage.data == zptlogo
True
>>> container.blobimage.contentType
'image/gif'
>>> container.blobimage.filename
'zpt.gif'

Note that is possible for force the mimetype:

>>> container.image = namedfile.NamedImage(zptlogo, contentType='image/foo', filename="zpt.gif")
>>> container.image.data == zptlogo
True
>>> container.image.contentType
'image/foo'
>>> container.image.filename
'zpt.gif'

>>> container.blobimage = namedfile.NamedBlobImage(zptlogo, contentType='image/foo', filename="zpt.gif")
>>> container.blobimage.data == zptlogo
True
>>> container.blobimage.contentType
'image/foo'
>>> container.blobimage.filename
'zpt.gif'

Download view

This package also comes with a view that can be used to download files. To use it, link to ../context-object/@@download/fieldname, where fieldname is the name of the attribute on the context-object where the named file is stored.

We will test this with a dummy request, faking traversal.

>>> from plone.namedfile.browser import Download
>>> from zope.publisher.browser import TestRequest

>>> request = TestRequest()
>>> download = Download(container, request).publishTraverse(request, 'simple')
>>> download()
'dummy test data'
>>> request.response.getHeader('Content-Length')
'15'
>>> request.response.getHeader('Content-Type')
'text/plain'
>>> request.response.getHeader('Content-Disposition')
'attachment; filename="test.txt"'

>>> request = TestRequest()
>>> download = Download(container, request).publishTraverse(request, 'blob')
>>> data = download()
>>> data #doctest: +ELLIPSIS
<open file ..., mode 'rb' at ...>
>>> data.read()
'dummy test data'

>>> request.response.getHeader('Content-Length')
'15'
>>> request.response.getHeader('Content-Type')
'text/plain'
>>> request.response.getHeader('Content-Disposition')
'attachment; filename="test.txt"'

>>> request = TestRequest()
>>> download = Download(container, request).publishTraverse(request, 'image')
>>> download() == zptlogo
True

>>> request.response.getHeader('Content-Length')
'341'
>>> request.response.getHeader('Content-Type')
'image/foo'
>>> request.response.getHeader('Content-Disposition')
'attachment; filename="zpt.gif"'

>>> request = TestRequest()
>>> download = Download(container, request).publishTraverse(request, 'blobimage')
>>> data = download()
>>> data #doctest: +ELLIPSIS
<open file ..., mode 'rb' at ...>
>>> data.read() == zptlogo
True

>>> request.response.getHeader('Content-Length')
'341'
>>> request.response.getHeader('Content-Type')
'image/foo'
>>> request.response.getHeader('Content-Disposition')
'attachment; filename="zpt.gif"'

Project details

Verified details

These details have been verified by PyPI
Owner
organization icon Plone
Maintainers
Avatar for davisagli from gravatar.com davisagli Avatar for esteele from gravatar.com esteele Avatar for laurencerowe from gravatar.com laurencerowe Avatar for miohtama from gravatar.com miohtama Avatar for optilude from gravatar.com optilude Avatar for timo from gravatar.com timo

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

6.3.1

6.3.0

6.2.3

6.2.2

6.2.1

6.2.0

6.1.3

6.1.2

6.1.1

6.1.0

6.0.3

6.0.2

6.0.1

6.0.0

6.0.0b5 pre-release

6.0.0b4 pre-release

6.0.0b3 pre-release

6.0.0b2 pre-release

6.0.0b1 pre-release

6.0.0a4 pre-release

6.0.0a3 pre-release

6.0.0a2 pre-release

6.0.0a1 pre-release

5.7.0

5.6.1

5.6.0

5.5.1

5.5.0

5.4.0

5.3.1

5.3.0

5.2.2

5.2.1

5.2.0

5.1.0

5.0.5

5.0.4

5.0.3

5.0.2

5.0.1

5.0

4.3.0

4.2.7

4.2.6

4.2.5

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.2

4.1.1

4.1

4.0

3.0.11

3.0.10

3.0.9

3.0.8

3.0.7

3.0.6

3.0.5

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

2.1.0

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0

1.0b8 pre-release

1.0b7 pre-release

1.0b6 pre-release

1.0b5 pre-release

1.0b4 pre-release

1.0b3 pre-release

1.0b2 pre-release

1.0b1 pre-release

This version

1.0a1 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plone.namedfile-1.0a1.tar.gz (13.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page