<!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" />
<title>Common Atom Elements — feedparser 5.1.3 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/feedparser.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '5.1.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="top" title="feedparser 5.1.3 documentation" href="index.html" />
<link rel="up" title="Basic Features" href="basic.html" />
<link rel="next" title="Getting Detailed Information on Atom Elements" href="atom-detail.html" />
<link rel="prev" title="Common RSS Elements" href="common-rss-elements.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="atom-detail.html" title="Getting Detailed Information on Atom Elements"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="common-rss-elements.html" title="Common RSS Elements"
accesskey="P">previous</a> |</li>
<li><a href="index.html">feedparser 5.1.3 documentation</a> »</li>
<li><a href="basic.html" accesskey="U">Basic Features</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="common-atom-elements">
<h1>Common Atom Elements<a class="headerlink" href="#common-atom-elements" title="Permalink to this headline">¶</a></h1>
<p>Atom feeds generally contain more information than <abbr title="Rich Site Summary">RSS</abbr>
feeds (because more elements are required), but the most commonly used elements
are still title, link, subtitle/description, various dates, and ID.</p>
<p>This sample Atom feed is at <a class="reference external" href="http://feedparser.org/docs/examples/atom10.xml">http://feedparser.org/docs/examples/atom10.xml</a>.</p>
<div class="highlight-xml"><div class="highlight"><pre><span class="cp"><?xml version="1.0" encoding="utf-8"?></span>
<span class="nt"><feed</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/2005/Atom"</span>
<span class="na">xml:base=</span><span class="s">"http://example.org/"</span>
<span class="na">xml:lang=</span><span class="s">"en"</span><span class="nt">></span>
<span class="nt"><title</span> <span class="na">type=</span><span class="s">"text"</span><span class="nt">></span>Sample Feed<span class="nt"></title></span>
<span class="nt"><subtitle</span> <span class="na">type=</span><span class="s">"html"</span><span class="nt">></span>
For documentation <span class="ni">&lt;</span>em<span class="ni">&gt;</span>only<span class="ni">&lt;</span>/em<span class="ni">&gt;</span>
<span class="nt"></subtitle></span>
<span class="nt"><link</span> <span class="na">rel=</span><span class="s">"alternate"</span> <span class="na">href=</span><span class="s">"/"</span><span class="nt">/></span>
<span class="nt"><link</span> <span class="na">rel=</span><span class="s">"self"</span>
<span class="na">type=</span><span class="s">"application/atom+xml"</span>
<span class="na">href=</span><span class="s">"http://www.example.org/atom10.xml"</span><span class="nt">/></span>
<span class="nt"><rights</span> <span class="na">type=</span><span class="s">"html"</span><span class="nt">></span>
<span class="ni">&lt;</span>p>Copyright 2005, Mark Pilgrim<span class="ni">&lt;</span>/p><span class="ni">&lt;</span>
<span class="nt"></rights></span>
<span class="nt"><id></span>tag:feedparser.org,2005-11-09:/docs/examples/atom10.xml<span class="nt"></id></span>
<span class="nt"><generator</span>
<span class="na">uri=</span><span class="s">"http://example.org/generator/"</span>
<span class="na">version=</span><span class="s">"4.0"</span><span class="nt">></span>
Sample Toolkit
<span class="nt"></generator></span>
<span class="nt"><updated></span>2005-11-09T11:56:34Z<span class="nt"></updated></span>
<span class="nt"><entry></span>
<span class="nt"><title></span>First entry title<span class="nt"></title></span>
<span class="nt"><link</span> <span class="na">rel=</span><span class="s">"alternate"</span>
<span class="na">href=</span><span class="s">"/entry/3"</span><span class="nt">/></span>
<span class="nt"><link</span> <span class="na">rel=</span><span class="s">"related"</span>
<span class="na">type=</span><span class="s">"text/html"</span>
<span class="na">href=</span><span class="s">"http://search.example.com/"</span><span class="nt">/></span>
<span class="nt"><link</span> <span class="na">rel=</span><span class="s">"via"</span>
<span class="na">type=</span><span class="s">"text/html"</span>
<span class="na">href=</span><span class="s">"http://toby.example.com/examples/atom10"</span><span class="nt">/></span>
<span class="nt"><link</span> <span class="na">rel=</span><span class="s">"enclosure"</span>
<span class="na">type=</span><span class="s">"video/mpeg4"</span>
<span class="na">href=</span><span class="s">"http://www.example.com/movie.mp4"</span>
<span class="na">length=</span><span class="s">"42301"</span><span class="nt">/></span>
<span class="nt"><id></span>tag:feedparser.org,2005-11-09:/docs/examples/atom10.xml:3<span class="nt"></id></span>
<span class="nt"><published></span>2005-11-09T00:23:47Z<span class="nt"></published></span>
<span class="nt"><updated></span>2005-11-09T11:56:34Z<span class="nt"></updated></span>
<span class="nt"><summary</span> <span class="na">type=</span><span class="s">"text/plain"</span> <span class="na">mode=</span><span class="s">"escaped"</span><span class="nt">></span>Watch out for nasty tricks<span class="nt"></summary></span>
<span class="nt"><content</span> <span class="na">type=</span><span class="s">"application/xhtml+xml"</span> <span class="na">mode=</span><span class="s">"xml"</span>
<span class="na">xml:base=</span><span class="s">"http://example.org/entry/3"</span> <span class="na">xml:lang=</span><span class="s">"en-US"</span><span class="nt">></span>
<span class="nt"><div</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/1999/xhtml"</span><span class="nt">></span>Watch out for
<span class="nt"><span</span> <span class="na">style=</span><span class="s">"background: url(javascript:window.location='http://example.org/')"</span><span class="nt">></span>
nasty tricks<span class="nt"></span></div></span>
<span class="nt"></content></span>
<span class="nt"></entry></span>
<span class="nt"></feed></span>
</pre></div>
</div>
<p>The feed elements are available in <tt class="docutils literal"><span class="pre">d.feed</span></tt>.</p>
<div class="section" id="accessing-common-feed-elements">
<h2>Accessing Common Feed Elements<a class="headerlink" href="#accessing-common-feed-elements" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">feedparser</span>
<span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="n">feedparser</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'http://feedparser.org/docs/examples/atom10.xml'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">feed</span><span class="o">.</span><span class="n">title</span>
<span class="go">u'Sample feed'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">feed</span><span class="o">.</span><span class="n">link</span>
<span class="go">u'http://example.org/'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">feed</span><span class="o">.</span><span class="n">subtitle</span>
<span class="go">u'For documentation <em>only</em>'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">feed</span><span class="o">.</span><span class="n">updated</span>
<span class="go">u'2005-11-09T11:56:34Z'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">feed</span><span class="o">.</span><span class="n">updated_parsed</span>
<span class="go">(2005, 11, 9, 11, 56, 34, 2, 313, 0)</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">feed</span><span class="o">.</span><span class="n">id</span>
<span class="go">u'tag:feedparser.org,2005-11-09:/docs/examples/atom10.xml'</span>
</pre></div>
</div>
<p>Entries are available in <tt class="docutils literal"><span class="pre">d.entries</span></tt>, which is a list. You access entries in
the order in which they appear in the original feed, so the first entry is
<tt class="docutils literal"><span class="pre">d.entries[0]</span></tt>.</p>
</div>
<div class="section" id="accessing-common-entry-elements">
<h2>Accessing Common Entry Elements<a class="headerlink" href="#accessing-common-entry-elements" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">feedparser</span>
<span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="n">feedparser</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'http://feedparser.org/docs/examples/atom10.xml'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">title</span>
<span class="go">u'First entry title'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">link</span>
<span class="go">u'http://example.org/entry/3</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">id</span>
<span class="go">u'tag:feedparser.org,2005-11-09:/docs/examples/atom10.xml:3'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">published</span>
<span class="go">u'2005-11-09T00:23:47Z'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">published_parsed</span>
<span class="go">(2005, 11, 9, 0, 23, 47, 2, 313, 0)</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">updated</span>
<span class="go">u'2005-11-09T11:56:34Z'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">updated_parsed</span>
<span class="go">(2005, 11, 9, 11, 56, 34, 2, 313, 0)</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">summary</span>
<span class="go">u'Watch out for nasty tricks'</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">entries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">content</span>
<span class="go">[{'type': u'application/xhtml+xml',</span>
<span class="go">'base': u'http://example.org/entry/3',</span>
<span class="go">'language': u'en-US',</span>
<span class="go">'value': u'<div>Watch out for <span>nasty tricks</span></div>'}]</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The parsed summary and content are not the same as they appear in the
original feed. The original elements contained dangerous <abbr title="HyperText Markup Language">HTML</abbr> markup which was sanitized. See
<a class="reference internal" href="html-sanitization.html#advanced-sanitization"><em>Sanitization</em></a> for details.</p>
</div>
<p>Because Atom entries can have more than one content element,
<tt class="docutils literal"><span class="pre">d.entries[0].content</span></tt> is a list of dictionaries. Each dictionary contains
metadata about a single content element. The two most important values in the
dictionary are the content type, in <tt class="docutils literal"><span class="pre">d.entries[0].content[0].type</span></tt>, and the
actual content value, in <tt class="docutils literal"><span class="pre">d.entries[0].content[0].value</span></tt>.</p>
<p>You can get this level of detail on other Atom elements too.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Common Atom Elements</a><ul>
<li><a class="reference internal" href="#accessing-common-feed-elements">Accessing Common Feed Elements</a></li>
<li><a class="reference internal" href="#accessing-common-entry-elements">Accessing Common Entry Elements</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="common-rss-elements.html"
title="previous chapter">Common <abbr title="Rich Site Summary">RSS</abbr> Elements</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="atom-detail.html"
title="next chapter">Getting Detailed Information on Atom Elements</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/common-atom-elements.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="atom-detail.html" title="Getting Detailed Information on Atom Elements"
>next</a> |</li>
<li class="right" >
<a href="common-rss-elements.html" title="Common RSS Elements"
>previous</a> |</li>
<li><a href="index.html">feedparser 5.1.3 documentation</a> »</li>
<li><a href="basic.html" >Basic Features</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2004-2008 Mark Pilgrim, 2010-2012 Kurt McKee.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
