Repository URL to install this package:
|
Version:
2.1.0.jo1 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module atom.core</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="atom.html"><font color="#ffffff">atom</font></a>.core</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/atom/core.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/atom/core.py</a></font></td></tr></table>
<p><tt># Copyright (C) 2008 Google Inc.<br>
#<br>
# Licensed under the Apache License, Version 2.0 (the "License");<br>
# you may not use this file except in compliance with the License.<br>
# You may obtain a copy of the License at<br>
#<br>
# <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
#<br>
# Unless required by applicable law or agreed to in writing, software<br>
# distributed under the License is distributed on an "AS IS" BASIS,<br>
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
# See the License for the specific language governing permissions and<br>
# limitations under the License.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="xml.etree.cElementTree.html">xml.etree.cElementTree</a><br>
</td><td width="25%" valign=top><a href="inspect.html">inspect</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="atom.core.html#XmlAttribute">XmlAttribute</a>
</font></dt><dt><font face="helvetica, arial"><a href="atom.core.html#XmlElement">XmlElement</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="XmlAttribute">class <strong>XmlAttribute</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="XmlAttribute-__init__"><strong>__init__</strong></a>(self, qname, value)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="XmlElement">class <strong>XmlElement</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Represents an element node in an XML document.<br>
<br>
The text member is a UTF-8 encoded str or unicode.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="XmlElement-FindChildren"><strong>FindChildren</strong></a> = <a href="#XmlElement-get_elements">get_elements</a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt></dl>
<dl><dt><a name="XmlElement-FindExtensions"><strong>FindExtensions</strong></a> = <a href="#XmlElement-get_elements">get_elements</a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt></dl>
<dl><dt><a name="XmlElement-GetAttributes"><strong>GetAttributes</strong></a> = <a href="#XmlElement-get_attributes">get_attributes</a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt></dl>
<dl><dt><a name="XmlElement-GetElements"><strong>GetElements</strong></a> = <a href="#XmlElement-get_elements">get_elements</a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt></dl>
<dl><dt><a name="XmlElement-ToString"><strong>ToString</strong></a> = <a href="#XmlElement-to_string">to_string</a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="XmlElement-__init__"><strong>__init__</strong></a>(self, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl>
<dl><dt><a name="XmlElement-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="XmlElement-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br>
<br>
To find all attributes in this <a href="__builtin__.html#object">object</a>, call get_attributes with the tag<br>
and namespace both set to None (the default). This method searches<br>
through the <a href="__builtin__.html#object">object</a>'s members and the attributes stored in<br>
_other_attributes which did not fit any of the XML parsing rules for this<br>
class.<br>
<br>
Args:<br>
tag: str<br>
namespace: str<br>
version: int Specifies the version of the XML rules to be used when<br>
searching for matching attributes.<br>
<br>
Returns:<br>
A list of <a href="#XmlAttribute">XmlAttribute</a> objects for the matching attributes.</tt></dd></dl>
<dl><dt><a name="XmlElement-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br>
<br>
To find all elements in this <a href="__builtin__.html#object">object</a>, call get_elements with the tag and<br>
namespace both set to None (the default). This method searches through<br>
the <a href="__builtin__.html#object">object</a>'s members and the elements stored in _other_elements which<br>
did not match any of the XML parsing rules for this class.<br>
<br>
Args:<br>
tag: str<br>
namespace: str<br>
version: int Specifies the version of the XML rules to be used when<br>
searching for matching elements.<br>
<br>
Returns:<br>
A list of the matching XmlElements.</tt></dd></dl>
<dl><dt><a name="XmlElement-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this <a href="__builtin__.html#object">object</a> to XML.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<dl><dt><strong>attributes</strong></dt>
</dl>
<dl><dt><strong>children</strong></dt>
</dl>
<dl><dt><strong>extension_attributes</strong></dt>
</dl>
<dl><dt><strong>extension_elements</strong></dt>
</dl>
<dl><dt><strong>namespace</strong></dt>
</dl>
<dl><dt><strong>tag</strong></dt>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>text</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-Parse"><strong>Parse</strong></a> = parse(xml_string, target_class<font color="#909090">=None</font>, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>)</dt><dd><tt>Parses the XML string according to the rules for the target_class.<br>
<br>
Args:<br>
xml_string: str or unicode<br>
target_class: <a href="#XmlElement">XmlElement</a> or a subclass. If None is specified, the<br>
<a href="#XmlElement">XmlElement</a> class is used.<br>
version: int (optional) The version of the schema which should be used when<br>
converting the XML into an <a href="__builtin__.html#object">object</a>. The default is 1.<br>
encoding: str (optional) The character encoding of the bytes in the<br>
xml_string. Default is 'UTF-8'.</tt></dd></dl>
<dl><dt><a name="-XmlElementFromString"><strong>XmlElementFromString</strong></a> = parse(xml_string, target_class<font color="#909090">=None</font>, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>)</dt><dd><tt>Parses the XML string according to the rules for the target_class.<br>
<br>
Args:<br>
xml_string: str or unicode<br>
target_class: <a href="#XmlElement">XmlElement</a> or a subclass. If None is specified, the<br>
<a href="#XmlElement">XmlElement</a> class is used.<br>
version: int (optional) The version of the schema which should be used when<br>
converting the XML into an <a href="__builtin__.html#object">object</a>. The default is 1.<br>
encoding: str (optional) The character encoding of the bytes in the<br>
xml_string. Default is 'UTF-8'.</tt></dd></dl>
<dl><dt><a name="-parse"><strong>parse</strong></a>(xml_string, target_class<font color="#909090">=None</font>, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>)</dt><dd><tt>Parses the XML string according to the rules for the target_class.<br>
<br>
Args:<br>
xml_string: str or unicode<br>
target_class: <a href="#XmlElement">XmlElement</a> or a subclass. If None is specified, the<br>
<a href="#XmlElement">XmlElement</a> class is used.<br>
version: int (optional) The version of the schema which should be used when<br>
converting the XML into an <a href="__builtin__.html#object">object</a>. The default is 1.<br>
encoding: str (optional) The character encoding of the bytes in the<br>
xml_string. Default is 'UTF-8'.</tt></dd></dl>
<dl><dt><a name="-xml_element_from_string"><strong>xml_element_from_string</strong></a> = parse(xml_string, target_class<font color="#909090">=None</font>, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>)</dt><dd><tt>Parses the XML string according to the rules for the target_class.<br>
<br>
Args:<br>
xml_string: str or unicode<br>
target_class: <a href="#XmlElement">XmlElement</a> or a subclass. If None is specified, the<br>
<a href="#XmlElement">XmlElement</a> class is used.<br>
version: int (optional) The version of the schema which should be used when<br>
converting the XML into an <a href="__builtin__.html#object">object</a>. The default is 1.<br>
encoding: str (optional) The character encoding of the bytes in the<br>
xml_string. Default is 'UTF-8'.</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>STRING_ENCODING</strong> = 'utf-8'<br>
<strong>__author__</strong> = 'j.s@google.com (Jeff Scudder)'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">j.s@google.com (Jeff Scudder)</td></tr></table>
</body></html>