2013-05-05 22:12:47 +02:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2017-10-14 21:48:00 +02:00
< title > feedgen.util — python-feedgen 0.6.1 documentation< / title >
2013-05-05 22:12:47 +02:00
< link rel = "stylesheet" href = "_static/lernfunk.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
2015-01-21 01:09:16 +01:00
URL_ROOT: './',
2017-10-14 21:48:00 +02:00
VERSION: '0.6.1',
2013-05-05 22:12:47 +02:00
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
2017-10-14 21:48:00 +02:00
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
2013-05-05 22:12:47 +02:00
};
< / 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 >
2017-01-05 01:58:23 +01:00
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2013-05-05 22:12:47 +02:00
< link rel = "next" title = "feedgen.ext.base" href = "ext/api.ext.base.html" / >
< link rel = "prev" title = "feedgen.entry" href = "api.entry.html" / >
< / head >
2017-01-05 01:58:23 +01:00
< body role = "document" >
< div class = "header" role = "banner" > < h1 class = "heading" > < a href = "index.html" >
2017-10-14 21:48:00 +02:00
< span > python-feedgen 0.6.1 documentation< / span > < / a > < / h1 >
2013-05-05 22:12:47 +02:00
< h2 class = "heading" > < span > feedgen.util< / span > < / h2 >
< / div >
2017-01-05 01:58:23 +01:00
< div class = "topnav" role = "navigation" aria-label = "top navigation" >
2013-05-05 22:12:47 +02:00
< p >
«    < a href = "api.entry.html" > feedgen.entry< / a >
    ::   
< a class = "uplink" href = "index.html" > Contents< / a >
    ::   
< a href = "ext/api.ext.base.html" > feedgen.ext.base< / a >     »
< / p >
< / div >
< div class = "content" >
2016-09-04 21:54:21 +02:00
< script type = application/javascript src = _static/theme_extras.js > < / script >
< div class = "apititle" > < b > Contents< / b > < / div >
2013-05-05 22:12:47 +02:00
< div class = "apitoc" > < / div > < span class = "target" id = "module-feedgen.util" > < / span > < div class = "section" id = "feedgen-util" >
< h1 > feedgen.util< a class = "headerlink" href = "#feedgen-util" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > This file contains helper functions for the feed generator module.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > copyright:< / th > < td class = "field-body" > 2013, Lars Kiesow < < a class = "reference external" href = "mailto:lkiesow%40uos.de" > lkiesow< span > @ < / span > uos< span > . < / span > de< / a > > < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > license:< / th > < td class = "field-body" > FreeBSD and LGPL, see license.* for more details.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "function" >
< dt id = "feedgen.util.ensure_format" >
2017-01-05 01:58:23 +01:00
< code class = "descclassname" > feedgen.util.< / code > < code class = "descname" > ensure_format< / code > < span class = "sig-paren" > (< / span > < em > val< / em > , < em > allowed< / em > , < em > required< / em > , < em > allowed_values=None< / em > , < em > defaults=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#feedgen.util.ensure_format" title = "Permalink to this definition" > ¶< / a > < / dt >
2013-05-05 22:12:47 +02:00
< dd > < p > Takes a dictionary or a list of dictionaries and check if all keys are in
the set of allowed keys, if all required keys are present and if the values
of a specific key are ok.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > val< / strong > – Dictionaries to check.< / li >
< li > < strong > allowed< / strong > – Set of allowed keys.< / li >
< li > < strong > required< / strong > – Set of required keys.< / li >
2017-01-05 01:58:23 +01:00
< li > < strong > allowed_values< / strong > – Dictionary with keys and sets of their allowed
values.< / li >
2014-01-01 19:53:25 +01:00
< li > < strong > defaults< / strong > – Dictionary with default values.< / li >
2013-05-05 22:12:47 +02:00
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first last" > List of checked dictionaries.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2016-09-04 21:54:21 +02:00
< dl class = "function" >
< dt id = "feedgen.util.formatRFC2822" >
2017-01-05 01:58:23 +01:00
< code class = "descclassname" > feedgen.util.< / code > < code class = "descname" > formatRFC2822< / code > < span class = "sig-paren" > (< / span > < em > d< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#feedgen.util.formatRFC2822" title = "Permalink to this definition" > ¶< / a > < / dt >
2016-09-04 21:54:21 +02:00
< dd > < p > Make sure the locale setting do not interfere with the time format.< / p >
< / dd > < / dl >
2013-05-05 22:12:47 +02:00
< / div >
< / div >
2017-01-05 01:58:23 +01:00
< div class = "bottomnav" role = "navigation" aria-label = "bottom navigation" >
2013-05-05 22:12:47 +02:00
< p >
«    < a href = "api.entry.html" > feedgen.entry< / a >
    ::   
< a class = "uplink" href = "index.html" > Contents< / a >
    ::   
< a href = "ext/api.ext.base.html" > feedgen.ext.base< / a >     »
< / p >
< / div >
2017-01-05 01:58:23 +01:00
< div class = "footer" role = "contentinfo" >
© Copyright 2013-2016, Lars Kiesow.
2017-10-14 21:48:00 +02:00
Created using < a href = "http://sphinx-doc.org/" > Sphinx< / a > 1.5.2.
2013-05-05 22:12:47 +02:00
< / div >
< / body >
< / html >
