2017-04-23 12:52:52 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2017-05-04 10:24:06 +00:00
< title > markdownx.exceptions — Django Markdownx 2.0.19 documentation< / title >
2017-04-23 12:52:52 +00:00
< link rel = "stylesheet" href = "../../_static/css/theme.css" type = "text/css" / >
< link rel = "index" title = "Index"
href="../../genindex.html"/>
< link rel = "search" title = "Search" href = "../../search.html" / >
2017-05-04 10:24:06 +00:00
< link rel = "top" title = "Django Markdownx 2.0.19 documentation" href = "../../index.html" / >
2017-04-23 12:52:52 +00:00
< link rel = "up" title = "Module code" href = "../index.html" / >
< script src = "../../_static/js/modernizr.min.js" > < / script >
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../../index.html" class = "icon icon-home" > Django Markdownx
< / a >
< div class = "version" >
2.0
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../installation.html" > Installation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../getting_started.html" > Getting Started< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../example.html" > Example< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../customization.html" > Customization< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../translation.html" > Translation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../js/js.html" > JavaScript< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../markdownx/markdownx.html" > MarkdownX Modules< / a > < / li >
2017-04-25 00:17:10 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../contribution.html" > Contributions< / a > < / li >
2017-04-23 12:52:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../license.html" > License< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../index.html" > Django Markdownx< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../index.html" > Docs< / a > » < / li >
< li > < a href = "../index.html" > Module code< / a > » < / li >
< li > markdownx.exceptions< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 > Source code for markdownx.exceptions< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "kn" > from< / span > < span class = "nn" > django.utils.translation< / span > < span class = "k" > import< / span > < span class = "n" > ugettext_lazy< / span > < span class = "k" > as< / span > < span class = "n" > _< / span >
< span class = "kn" > from< / span > < span class = "nn" > django.forms< / span > < span class = "k" > import< / span > < span class = "n" > ValidationError< / span >
< div class = "viewcode-block" id = "MarkdownxImageUploadError" > < a class = "viewcode-back" href = "../../markdownx/docs/exceptions.html#markdownx.exceptions.MarkdownxImageUploadError" > [docs]< / a > < span class = "k" > class< / span > < span class = "nc" > MarkdownxImageUploadError< / span > < span class = "p" > (< / span > < span class = "n" > ValidationError< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " < / span >
2017-04-25 00:17:10 +00:00
< span class = "sd" > Custom **MarkdownX** exceptions. < / span >
2017-04-23 12:52:52 +00:00
< span class = "sd" > " " " < / span >
< span class = "nd" > @staticmethod< / span >
< div class = "viewcode-block" id = "MarkdownxImageUploadError.not_uploaded" > < a class = "viewcode-back" href = "../../markdownx/docs/exceptions.html#markdownx.exceptions.MarkdownxImageUploadError.not_uploaded" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > not_uploaded< / span > < span class = "p" > ():< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > No file is available to upload.< / span >
2017-04-25 00:17:10 +00:00
< span class = "sd" > :return: Locale compatible version of the error with the following message:< / span >
< span class = "sd" > < / span >
< span class = "sd" > - No files have been uploaded.< / span >
< span class = "sd" > < / span >
< span class = "sd" > :rtype: MarkdownxImageUploadError< / span >
2017-04-23 12:52:52 +00:00
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > MarkdownxImageUploadError< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "p" > (< / span > < span class = "s1" > ' No files have been uploaded.' < / span > < span class = "p" > ))< / span > < / div >
< span class = "nd" > @staticmethod< / span >
< div class = "viewcode-block" id = "MarkdownxImageUploadError.unsupported_format" > < a class = "viewcode-back" href = "../../markdownx/docs/exceptions.html#markdownx.exceptions.MarkdownxImageUploadError.unsupported_format" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > unsupported_format< / span > < span class = "p" > ():< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > The file is of a format not defined in :guilabel:`settings.py`< / span >
< span class = "sd" > or if default, in :guilabel:`markdownx/settings.py`.< / span >
2017-04-25 00:17:10 +00:00
< span class = "sd" > :return: Locale compatible version of the error with the following message:< / span >
< span class = "sd" > < / span >
< span class = "sd" > - File type is not supported. < / span >
< span class = "sd" > < / span >
< span class = "sd" > :rtype: MarkdownxImageUploadError< / span >
2017-04-23 12:52:52 +00:00
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > MarkdownxImageUploadError< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "p" > (< / span > < span class = "s1" > ' File type is not supported.' < / span > < span class = "p" > ))< / span > < / div >
< span class = "nd" > @staticmethod< / span >
< div class = "viewcode-block" id = "MarkdownxImageUploadError.invalid_size" > < a class = "viewcode-back" href = "../../markdownx/docs/exceptions.html#markdownx.exceptions.MarkdownxImageUploadError.invalid_size" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > invalid_size< / span > < span class = "p" > (< / span > < span class = "n" > current< / span > < span class = "p" > ,< / span > < span class = "n" > expected< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > The file is larger in size that the maximum allow in :guilabel:`settings.py` (or the default).< / span >
2017-04-25 00:17:10 +00:00
< span class = "sd" > :param current: Current size of the file.< / span >
< span class = "sd" > :type current: float, int< / span >
< span class = "sd" > :param expected: Expected (maximum permitted) size of the file.< / span >
< span class = "sd" > :type expected: float, int< / span >
< span class = "sd" > :return: Locale compatible version of the error with the following message:< / span >
< span class = "sd" > < / span >
< span class = "sd" > - Please keep file size under %(max)s. Current file size: %(current)s.' < / span >
< span class = "sd" > < / span >
< span class = "sd" > :rtype: MarkdownxImageUploadError< / span >
2017-04-23 12:52:52 +00:00
< span class = "sd" > " " " < / span >
< span class = "kn" > from< / span > < span class = "nn" > django.template.defaultfilters< / span > < span class = "k" > import< / span > < span class = "n" > filesizeformat< / span >
< span class = "k" > return< / span > < span class = "n" > MarkdownxImageUploadError< / span > < span class = "p" > (< / span >
< span class = "n" > _< / span > < span class = "p" > (< / span > < span class = "s1" > ' Please keep file size under < / span > < span class = "si" > %(max)s< / span > < span class = "s1" > . Current file size: < / span > < span class = "si" > %(current)s< / span > < span class = "s1" > .' < / span > < span class = "p" > )< / span > < span class = "o" > %< / span > < span class = "p" > {< / span >
< span class = "s1" > ' max' < / span > < span class = "p" > :< / span > < span class = "n" > filesizeformat< / span > < span class = "p" > (< / span > < span class = "n" > expected< / span > < span class = "p" > ),< / span >
< span class = "s1" > ' current' < / span > < span class = "p" > :< / span > < span class = "n" > filesizeformat< / span > < span class = "p" > (< / span > < span class = "n" > current< / span > < span class = "p" > )< / span >
< span class = "p" > }< / span >
< span class = "p" > )< / span > < / div > < / div >
< / pre > < / div >
< / div >
< div class = "articleComments" >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2017 - Adi, Pouria Hadjibagheri.
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
2017-05-04 10:24:06 +00:00
VERSION:'2.0.19',
2017-04-23 12:52:52 +00:00
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
< / script >
< script type = "text/javascript" src = "../../_static/jquery.js" > < / script >
< script type = "text/javascript" src = "../../_static/underscore.js" > < / script >
< script type = "text/javascript" src = "../../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" > < / script >
< script type = "text/javascript" src = "../../_static/js/theme.js" > < / script >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
< / script >
< / body >
< / html >
