parthtamu/rag-code-assistant
0
1<!DOCTYPE html>2 3<html lang="en" data-content_root="../">4 <head>5 <meta charset="utf-8" />6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />7<meta property="og:title" content="grp — The group database" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/grp.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="This module provides access to the Unix group database. It is available on all Unix versions. Availability: Unix, not WASI, not Android, not iOS. Group database entries are reported as a tuple-like..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_grp_ecef6dc0.png" />15<meta property="og:image:alt" content="This module provides access to the Unix group database. It is available on all Unix versions. Availability: Unix, not WASI, not Android, not iOS. Group database entries are reported as a tuple-like..." />16<meta name="description" content="This module provides access to the Unix group database. It is available on all Unix versions. Availability: Unix, not WASI, not Android, not iOS. Group database entries are reported as a tuple-like..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20 <title>grp — The group database — Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21 22 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25 <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27 28 <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29 <script src="../_static/doctools.js?v=9bcbadda"></script>30 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31 <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32 33 <script src="../_static/sidebar.js"></script>34 35 <link rel="search" type="application/opensearchdescription+xml"36 title="Search within Python 3.15.0a6 documentation"37 href="../_static/opensearch.xml"/>38 <link rel="author" title="About these documents" href="../about.html" />39 <link rel="index" title="Index" href="../genindex.html" />40 <link rel="search" title="Search" href="../search.html" />41 <link rel="copyright" title="Copyright" href="../copyright.html" />42 <link rel="next" title="termios — POSIX style tty control" href="termios.html" />43 <link rel="prev" title="pwd — The password database" href="pwd.html" />44 45 46 <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47 48 <link rel="canonical" href="https://docs.python.org/3/library/grp.html">49 50 51 52 53 <style>54 @media only screen {55 table.full-width-table {56 width: 100%;57 }58 }59 </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61 <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62 <script type="text/javascript" src="../_static/copybutton.js"></script>63 <script type="text/javascript" src="../_static/menu.js"></script>64 <script type="text/javascript" src="../_static/search-focus.js"></script>65 <script type="text/javascript" src="../_static/themetoggle.js"></script> 66 <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67 <meta name="readthedocs-addons-api-version" content="1">68 69 </head>70<body>71<div class="mobile-nav">72 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74 <nav class="nav-content" role="navigation">75 <label for="menuToggler" class="toggler__label">76 <span></span>77 </label>78 <span class="nav-items-wrapper">79 <a href="https://www.python.org/" class="nav-logo">80 <img src="../_static/py.svg" alt="Python logo">81 </a>82 <span class="version_switcher_placeholder"></span>83 <form role="search" class="search" action="../search.html" method="get">84 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>86 </svg>87 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88 <input type="submit" value="Go">89 </form>90 </span>91 </nav>92 <div class="menu-wrapper">93 <nav class="menu" role="navigation" aria-label="main navigation">94 <div class="language_switcher_placeholder"></div>95 96<label class="theme-selector-label">97 Theme98 <select class="theme-selector" oninput="activateTheme(this.value)">99 <option value="auto" selected>Auto</option>100 <option value="light">Light</option>101 <option value="dark">Dark</option>102 </select>103</label>104 <div>105 <h4>Previous topic</h4>106 <p class="topless"><a href="pwd.html"107 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pwd</span></code> — The password database</a></p>108 </div>109 <div>110 <h4>Next topic</h4>111 <p class="topless"><a href="termios.html"112 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">termios</span></code> — POSIX style tty control</a></p>113 </div>114 <script>115 document.addEventListener('DOMContentLoaded', () => {116 const title = document.querySelector('meta[property="og:title"]').content;117 const elements = document.querySelectorAll('.improvepage');118 const pageurl = window.location.href.split('?')[0];119 elements.forEach(element => {120 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));121 url.searchParams.set('pagetitle', title);122 url.searchParams.set('pageurl', pageurl);123 url.searchParams.set('pagesource', "library/grp.rst");124 element.href = url.toString();125 });126 });127 </script>128 <div role="note" aria-label="source link">129 <h3>This page</h3>130 <ul class="this-page-menu">131 <li><a href="../bugs.html">Report a bug</a></li>132 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>133 <li>134 <a href="https://github.com/python/cpython/blob/main/Doc/library/grp.rst?plain=1"135 rel="nofollow">Show source136 </a>137 </li>138 139 </ul>140 </div>141 </nav>142 </div>143</div>144 145 146 <div class="related" role="navigation" aria-label="Related">147 <h3>Navigation</h3>148 <ul>149 <li class="right" style="margin-right: 10px">150 <a href="../genindex.html" title="General Index"151 accesskey="I">index</a></li>152 <li class="right" >153 <a href="../py-modindex.html" title="Python Module Index"154 >modules</a> |</li>155 <li class="right" >156 <a href="termios.html" title="termios — POSIX style tty control"157 accesskey="N">next</a> |</li>158 <li class="right" >159 <a href="pwd.html" title="pwd — The password database"160 accesskey="P">previous</a> |</li>161 162 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>163 <li><a href="https://www.python.org/">Python</a> »</li>164 <li class="switchers">165 <div class="language_switcher_placeholder"></div>166 <div class="version_switcher_placeholder"></div>167 </li>168 <li>169 170 </li>171 <li id="cpython-language-and-version">172 <a href="../index.html">3.15.0a6 Documentation</a> »173 </li>174 175 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>176 <li class="nav-item nav-item-2"><a href="unix.html" accesskey="U">Unix-specific services</a> »</li>177 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">grp</span></code> — The group database</a></li>178 <li class="right">179 180 181 <div class="inline-search" role="search">182 <form class="inline-search" action="../search.html" method="get">183 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">184 <input type="submit" value="Go">185 </form>186 </div>187 |188 </li>189 <li class="right">190<label class="theme-selector-label">191 Theme192 <select class="theme-selector" oninput="activateTheme(this.value)">193 <option value="auto" selected>Auto</option>194 <option value="light">Light</option>195 <option value="dark">Dark</option>196 </select>197</label> |</li>198 199 </ul>200 </div> 201 202 <div class="document">203 <div class="documentwrapper">204 <div class="bodywrapper">205 <div class="body" role="main">206 207 <section id="module-grp">208<span id="grp-the-group-database"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">grp</span></code> — The group database<a class="headerlink" href="#module-grp" title="Link to this heading">¶</a></h1>209<hr class="docutils" />210<p>This module provides access to the Unix group database. It is available on all211Unix versions.</p>212<div class="availability docutils container">213<p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: Unix, not WASI, not Android, not iOS.</p>214</div>215<p>Group database entries are reported as a tuple-like object, whose attributes216correspond to the members of the <code class="docutils literal notranslate"><span class="pre">group</span></code> structure (Attribute field below, see217<code class="docutils literal notranslate"><span class="pre"><grp.h></span></code>):</p>218<table class="docutils align-default">219<thead>220<tr class="row-odd"><th class="head"><p>Index</p></th>221<th class="head"><p>Attribute</p></th>222<th class="head"><p>Meaning</p></th>223</tr>224</thead>225<tbody>226<tr class="row-even"><td><p>0</p></td>227<td><p>gr_name</p></td>228<td><p>the name of the group</p></td>229</tr>230<tr class="row-odd"><td><p>1</p></td>231<td><p>gr_passwd</p></td>232<td><p>the (encrypted) group password;233often empty</p></td>234</tr>235<tr class="row-even"><td><p>2</p></td>236<td><p>gr_gid</p></td>237<td><p>the numerical group ID</p></td>238</tr>239<tr class="row-odd"><td><p>3</p></td>240<td><p>gr_mem</p></td>241<td><p>all the group member’s user242names</p></td>243</tr>244</tbody>245</table>246<p>The gid is an integer, name and password are strings, and the member list is a247list of strings. (Note that most users are not explicitly listed as members of248the group they are in according to the password database. Check both databases249to get complete membership information. Also note that a <code class="docutils literal notranslate"><span class="pre">gr_name</span></code> that250starts with a <code class="docutils literal notranslate"><span class="pre">+</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code> is likely to be a YP/NIS reference and may not be251accessible via <a class="reference internal" href="#grp.getgrnam" title="grp.getgrnam"><code class="xref py py-func docutils literal notranslate"><span class="pre">getgrnam()</span></code></a> or <a class="reference internal" href="#grp.getgrgid" title="grp.getgrgid"><code class="xref py py-func docutils literal notranslate"><span class="pre">getgrgid()</span></code></a>.)</p>252<p>It defines the following items:</p>253<dl class="py function">254<dt class="sig sig-object py" id="grp.getgrgid">255<span class="sig-prename descclassname"><span class="pre">grp.</span></span><span class="sig-name descname"><span class="pre">getgrgid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#grp.getgrgid" title="Link to this definition">¶</a></dt>256<dd><p>Return the group database entry for the given numeric group ID. <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a>257is raised if the entry asked for cannot be found.</p>258<div class="versionchanged">259<p><span class="versionmodified changed">Changed in version 3.10: </span><a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> is raised for non-integer arguments like floats or strings.</p>260</div>261</dd></dl>262 263<dl class="py function">264<dt class="sig sig-object py" id="grp.getgrnam">265<span class="sig-prename descclassname"><span class="pre">grp.</span></span><span class="sig-name descname"><span class="pre">getgrnam</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#grp.getgrnam" title="Link to this definition">¶</a></dt>266<dd><p>Return the group database entry for the given group name. <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> is267raised if the entry asked for cannot be found.</p>268</dd></dl>269 270<dl class="py function">271<dt class="sig sig-object py" id="grp.getgrall">272<span class="sig-prename descclassname"><span class="pre">grp.</span></span><span class="sig-name descname"><span class="pre">getgrall</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#grp.getgrall" title="Link to this definition">¶</a></dt>273<dd><p>Return a list of all available group entries, in arbitrary order.</p>274</dd></dl>275 276<div class="admonition seealso">277<p class="admonition-title">See also</p>278<dl class="simple">279<dt>Module <a class="reference internal" href="pwd.html#module-pwd" title="pwd: The password database (getpwnam() and friends)."><code class="xref py py-mod docutils literal notranslate"><span class="pre">pwd</span></code></a></dt><dd><p>An interface to the user database, similar to this.</p>280</dd>281</dl>282</div>283</section>284 285 286 <div class="clearer"></div>287 </div>288 </div>289 </div>290 <div class="sphinxsidebar" role="navigation" aria-label="Main">291 <div class="sphinxsidebarwrapper">292 <div>293 <h4>Previous topic</h4>294 <p class="topless"><a href="pwd.html"295 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pwd</span></code> — The password database</a></p>296 </div>297 <div>298 <h4>Next topic</h4>299 <p class="topless"><a href="termios.html"300 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">termios</span></code> — POSIX style tty control</a></p>301 </div>302 <script>303 document.addEventListener('DOMContentLoaded', () => {304 const title = document.querySelector('meta[property="og:title"]').content;305 const elements = document.querySelectorAll('.improvepage');306 const pageurl = window.location.href.split('?')[0];307 elements.forEach(element => {308 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));309 url.searchParams.set('pagetitle', title);310 url.searchParams.set('pageurl', pageurl);311 url.searchParams.set('pagesource', "library/grp.rst");312 element.href = url.toString();313 });314 });315 </script>316 <div role="note" aria-label="source link">317 <h3>This page</h3>318 <ul class="this-page-menu">319 <li><a href="../bugs.html">Report a bug</a></li>320 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>321 <li>322 <a href="https://github.com/python/cpython/blob/main/Doc/library/grp.rst?plain=1"323 rel="nofollow">Show source324 </a>325 </li>326 327 </ul>328 </div>329 </div>330<div id="sidebarbutton" title="Collapse sidebar">331<span>«</span>332</div>333 334 </div>335 <div class="clearer"></div>336 </div> 337 <div class="related" role="navigation" aria-label="Related">338 <h3>Navigation</h3>339 <ul>340 <li class="right" style="margin-right: 10px">341 <a href="../genindex.html" title="General Index"342 >index</a></li>343 <li class="right" >344 <a href="../py-modindex.html" title="Python Module Index"345 >modules</a> |</li>346 <li class="right" >347 <a href="termios.html" title="termios — POSIX style tty control"348 >next</a> |</li>349 <li class="right" >350 <a href="pwd.html" title="pwd — The password database"351 >previous</a> |</li>352 353 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>354 <li><a href="https://www.python.org/">Python</a> »</li>355 <li class="switchers">356 <div class="language_switcher_placeholder"></div>357 <div class="version_switcher_placeholder"></div>358 </li>359 <li>360 361 </li>362 <li id="cpython-language-and-version">363 <a href="../index.html">3.15.0a6 Documentation</a> »364 </li>365 366 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>367 <li class="nav-item nav-item-2"><a href="unix.html" >Unix-specific services</a> »</li>368 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">grp</span></code> — The group database</a></li>369 <li class="right">370 371 372 <div class="inline-search" role="search">373 <form class="inline-search" action="../search.html" method="get">374 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">375 <input type="submit" value="Go">376 </form>377 </div>378 |379 </li>380 <li class="right">381<label class="theme-selector-label">382 Theme383 <select class="theme-selector" oninput="activateTheme(this.value)">384 <option value="auto" selected>Auto</option>385 <option value="light">Light</option>386 <option value="dark">Dark</option>387 </select>388</label> |</li>389 390 </ul>391 </div> 392 <div class="footer">393 © <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.394 <br>395 This page is licensed under the Python Software Foundation License Version 2.396 <br>397 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.398 <br>399 400 See <a href="/license.html">History and License</a> for more information.<br>401 402 403 <br>404 405 The Python Software Foundation is a non-profit corporation.406<a href="https://www.python.org/psf/donations/">Please donate.</a>407<br>408 <br>409 Last updated on Mar 10, 2026 (08:58 UTC).410 411 <a href="/bugs.html">Found a bug</a>?412 413 <br>414 415 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.416 </div>417 418 </body>419</html>