fobi.contrib.plugins.form_elements.content.content_image package

Submodules

fobi.contrib.plugins.form_elements.content.content_image.apps module

class fobi.contrib.plugins.form_elements.content.content_image.apps.Config(app_name, app_module)

Bases: django.apps.config.AppConfig

Config.

label = 'fobi_contrib_plugins_form_elements_content_content_image'

name = 'fobi.contrib.plugins.form_elements.content.content_image'

fobi.contrib.plugins.form_elements.content.content_image.base module

class fobi.contrib.plugins.form_elements.content.content_image.base.ContentImagePlugin(user=None)

Bases: fobi.base.FormElementPlugin

Content image plugin.

clone_plugin_data(entry)

Clone plugin data.

Clone plugin data, which means we make a copy of the original image.

TODO: Perhaps rely more on data of form_element_entry?

delete_plugin_data()

Delete uploaded file.

form

alias of ContentImageForm

get_form_field_instances(request=None, form_entry=None, form_element_entries=None, **kwargs)

Get form field instances.

get_raw_data()

Get raw data.

Might be used in integration plugins.

get_rendered_image()

Get rendered image.

group = <django.utils.functional.__proxy__ object>

name = <django.utils.functional.__proxy__ object>

post_processor()

Post process data.

Always the same.

uid = 'content_image'

fobi.contrib.plugins.form_elements.content.content_image.conf module

fobi.contrib.plugins.form_elements.content.content_image.conf.get_setting(setting, override=None)

Get setting.

Get a setting from fobi.contrib.plugins.form_elements.content.content_image conf module, falling back to the default.

If override is not None, it will be used instead of the setting.

Parameters:

• setting – String with setting name
• override – Value to use when no setting is available. Defaults to None.

Returns:

Setting value.

fobi.contrib.plugins.form_elements.content.content_image.defaults module

fobi.contrib.plugins.form_elements.content.content_image.fobi_form_elements module

class fobi.contrib.plugins.form_elements.content.content_image.fobi_form_elements.ContentImagePlugin(user=None)

Bases: fobi.base.FormElementPlugin

Content image plugin.

clone_plugin_data(entry)

Clone plugin data.

Clone plugin data, which means we make a copy of the original image.

TODO: Perhaps rely more on data of form_element_entry?

delete_plugin_data()

Delete uploaded file.

form

alias of ContentImageForm

get_form_field_instances(request=None, form_entry=None, form_element_entries=None, **kwargs)

Get form field instances.

get_raw_data()

Get raw data.

Might be used in integration plugins.

get_rendered_image()

Get rendered image.

group = <django.utils.functional.__proxy__ object>

name = <django.utils.functional.__proxy__ object>

post_processor()

Post process data.

Always the same.

uid = 'content_image'

fobi.contrib.plugins.form_elements.content.content_image.forms module

class fobi.contrib.plugins.form_elements.content.content_image.forms.ContentImageForm(data=None, files=None, auto_id=u'id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None)

Bases: django.forms.forms.Form, fobi.base.BasePluginForm

Form for ContentImagePlugin.

base_fields = OrderedDict([('file', <django.forms.fields.ImageField object at 0x7f5a5e95e610>), ('alt', <django.forms.fields.CharField object at 0x7f5a5e95e650>), ('fit_method', <django.forms.fields.ChoiceField object at 0x7f5a5e95e710>), ('size', <django.forms.fields.ChoiceField object at 0x7f5a5e95e7d0>)])

declared_fields = OrderedDict([('file', <django.forms.fields.ImageField object at 0x7f5a5e95e610>), ('alt', <django.forms.fields.CharField object at 0x7f5a5e95e650>), ('fit_method', <django.forms.fields.ChoiceField object at 0x7f5a5e95e710>), ('size', <django.forms.fields.ChoiceField object at 0x7f5a5e95e7d0>)])

media

plugin_data_fields = [('file', ''), ('alt', ''), ('fit_method', 'center'), ('size', '500x500')]

save_plugin_data(request=None)

Saving the plugin data and moving the file.

fobi.contrib.plugins.form_elements.content.content_image.helpers module

fobi.contrib.plugins.form_elements.content.content_image.helpers.clone_file(source_filename, relative_path=True)

Clone the file.

Parameters:source_filename (string) – Source filename. Return string:Filename of the cloned file.

fobi.contrib.plugins.form_elements.content.content_image.helpers.delete_file(image_file)

Delete file from disc.

fobi.contrib.plugins.form_elements.content.content_image.helpers.ensure_unique_filename(destination)

Makes sure filenames are never overwritten.

Parameters:destination (string) – Return string:

fobi.contrib.plugins.form_elements.content.content_image.helpers.get_crop_filter(fit_method)

Get crop filter.

fobi.contrib.plugins.form_elements.content.content_image.helpers.handle_uploaded_file(image_file)

Handle uploaded file.

Parameters:image_file (django.core.files.uploadedfile.InMemoryUploadedFile) – Return string:Path to the image (relative).

fobi.contrib.plugins.form_elements.content.content_image.settings module

• FIT_METHOD_CROP_SMART (string)
• FIT_METHOD_CROP_CENTER (string)
• FIT_METHOD_CROP_SCALE (string)
• FIT_METHOD_FIT_WIDTH (string)
• FIT_METHOD_FIT_HEIGHT (string)
• DEFAULT_FIT_METHOD (string)
• FIT_METHODS_CHOICES (tuple)
• FIT_METHODS_CHOICES_WITH_EMPTY_OPTION (list)
• IMAGES_UPLOAD_DIR (string)

Module contents