sam-t2/devtools/v9/html/python/lib/netrc-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="module-netrc.html" />
<link rel="parent" href="module-netrc.html" />
<link rel="next" href="module-robotparser.html" />
<meta name='aesop' content='information' />
<title>12.18.1 netrc Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.18 netrc  "
  href="module-netrc.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="12.18 netrc  "
  href="module-netrc.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="12.19 robotparser  "
  href="module-robotparser.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-netrc.html">12.18 netrc  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-netrc.html">12.18 netrc  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-robotparser.html">12.19 robotparser  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION00141810000000000000000"></A><A NAME="netrc-objects"></A>
<BR>
12.18.1 netrc Objects
</H2>

<P>
A <tt class="class">netrc</tt> instance has the following methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4197' xml:id='l2h-4197' class="method">authenticators</tt></b>(</nobr></td>
  <td><var>host</var>)</td></tr></table></dt>
<dd>
Return a 3-tuple <code>(<var>login</var>, <var>account</var>, <var>password</var>)</code>
of authenticators for <var>host</var>.  If the netrc file did not
contain an entry for the given host, return the tuple associated with
the `default' entry.  If neither matching host nor default entry is
available, return <code>None</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4198' xml:id='l2h-4198' class="method">__repr__</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Dump the class data as a string in the format of a netrc file.
(This discards comments and may reorder the entries.)
</dl>

<P>
Instances of <tt class="class">netrc</tt> have public instance variables:

<P>
<dl><dt><b><tt id='l2h-4199' xml:id='l2h-4199' class="member">hosts</tt></b></dt>
<dd>
Dictionary mapping host names to <code>(<var>login</var>, <var>account</var>,
<var>password</var>)</code> tuples.  The `default' entry, if any, is represented
as a pseudo-host by that name.
</dl>

<P>
<dl><dt><b><tt id='l2h-4200' xml:id='l2h-4200' class="member">macros</tt></b></dt>
<dd>
Dictionary mapping macro names to string lists.
</dl>

<P>
<span class="note"><b class="label">Note:</b>
Passwords are limited to a subset of the ASCII character set.
Versions of this module prior to 2.3 were extremely limited.  Starting with
2.3, all ASCII punctuation is allowed in passwords.  However, note that
whitespace and non-printable characters are not allowed in passwords.  This
is a limitation of the way the .netrc file is parsed and may be removed in
the future.</span>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.18 netrc  "
  href="module-netrc.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="12.18 netrc  "
  href="module-netrc.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="12.19 robotparser  "
  href="module-robotparser.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-netrc.html">12.18 netrc  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-netrc.html">12.18 netrc  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-robotparser.html">12.19 robotparser  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>