Package couchdbkit :: Package schema :: Module base :: Class AttachmentMixin

Class AttachmentMixin

object --+
         |
        AttachmentMixin

Known Subclasses:

Document

mixin to manage doc attachments.

Instance Methods

[hide private]

put_attachment(self, content, name=None, content_type=None, content_length=None)
Add attachement to a document.

source code

delete_attachment(self, name)
delete document attachment

source code

fetch_attachment(self, name, stream=False)
get attachment in a adocument

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

put_attachment(self, content, name=None, content_type=None, content_length=None)

source code

Add attachement to a document.

Parameters:

content - string or :obj:`File` object.
name - name or attachment (file name).
content_type - string, mimetype of attachment. If you don't set it, it will be autodetected.
content_lenght - int, size of attachment.

Returns:

bool, True if everything was ok.

delete_attachment(self, name)

source code

delete document attachment

Parameters:

name - name of attachment

Returns:

dict, with member ok set to True if delete was ok.

fetch_attachment(self, name, stream=False)

source code

get attachment in a adocument

Parameters:

name - name of attachment default: default result
stream - boolean, response return a ResponseStream object
stream_size - int, size in bytes of response stream block

Returns:

str or unicode, attachment