sam-t2/devtools/v9/html/python/lib/module-grp.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="next" href="module-crypt.html" />
<link rel="prev" href="module-pwd.html" />
<link rel="parent" href="unix.html" />
<link rel="next" href="module-crypt.html" />
<meta name='aesop' content='information' />
<title>8.3 grp -- The group database</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="8.2 pwd  "
  href="module-pwd.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="8. Unix Specific Services"
  href="unix.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="8.4 crypt  "
  href="module-crypt.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-pwd.html">8.2 pwd  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="unix.html">8. Unix Specific Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-crypt.html">8.4 crypt  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0010300000000000000000">
8.3 <tt class="module">grp</tt> --
         The group database</A>
</H1>

<P>
<A NAME="module-grp"></A>
<p class="availability">Availability: <span
 class="platform">Unix</span>.</p>

<P>
This module provides access to the <span class="Unix">Unix</span> group database.
It is available on all <span class="Unix">Unix</span> versions.

<P>
Group database entries are reported as a tuple-like object, whose
attributes correspond to the members of the <code>group</code> structure
(Attribute field below, see <code>&lt;pwd.h&gt;</code>):

<P>
<div class="center"><table class="realtable">
  <thead>
    <tr>
      <th class="right" >Index</th>
      <th class="left"  >Attribute</th>
      <th class="left"  >Meaning</th>
      </tr>
    </thead>
  <tbody>
    <tr><td class="right"  valign="baseline">0</td>
        <td class="left"  >gr_name</td>
        <td class="left"  >the name of the group</td></tr>
    <tr><td class="right"  valign="baseline">1</td>
        <td class="left"  >gr_passwd</td>
        <td class="left"  >the (encrypted) group password; often empty</td></tr>
    <tr><td class="right"  valign="baseline">2</td>
        <td class="left"  >gr_gid</td>
        <td class="left"  >the numerical group ID</td></tr>
    <tr><td class="right"  valign="baseline">3</td>
        <td class="left"  >gr_mem</td>
        <td class="left"  >all the group member's  user  names</td></tr></tbody>
</table></div>

<P>
The gid is an integer, name and password are strings, and the member
list is a list of strings.
(Note that most users are not explicitly listed as members of the
group they are in according to the password database.  Check both
databases to get complete membership information.)

<P>
It defines the following items:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2978' xml:id='l2h-2978' class="function">getgrgid</tt></b>(</nobr></td>
  <td><var>gid</var>)</td></tr></table></dt>
<dd>
Return the group database entry for the given numeric group ID.
<tt class="exception">KeyError</tt> is raised if the entry asked for cannot be found.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2979' xml:id='l2h-2979' class="function">getgrnam</tt></b>(</nobr></td>
  <td><var>name</var>)</td></tr></table></dt>
<dd>
Return the group database entry for the given group name.
<tt class="exception">KeyError</tt> is raised if the entry asked for cannot be found.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2980' xml:id='l2h-2980' class="function">getgrall</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return a list of all available group entries, in arbitrary order.
</dl>

<P>
<div class="seealso">
  <p class="heading">See Also:</p>

  <dl compact="compact" class="seemodule">
    <dt>Module <b><tt class="module"><a href="module-pwd.html">pwd</a></tt>:</b>
    <dd>An interface to the user database, similar to this.
  </dl>
</div>

<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="8.2 pwd  "
  href="module-pwd.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="8. Unix Specific Services"
  href="unix.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="8.4 crypt  "
  href="module-crypt.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-pwd.html">8.2 pwd  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="unix.html">8. Unix Specific Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-crypt.html">8.4 crypt  </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>