35.4.grp — The group database


This module provides access to the Unix group database. It is available on allUnix versions.

Group database entries are reported as a tuple-like object, whose attributescorrespond to the members of thegroup structure (Attribute field below, see<pwd.h>):

IndexAttributeMeaning
0gr_namethe name of the group
1gr_passwdthe (encrypted) group password;often empty
2gr_gidthe numerical group ID
3gr_memall the group member’s usernames

The gid is an integer, name and password are strings, and the member list is alist of strings. (Note that most users are not explicitly listed as members ofthe group they are in according to the password database. Check both databasesto get complete membership information. Also note that agr_name thatstarts with a+ or- is likely to be a YP/NIS reference and may not beaccessible viagetgrnam() orgetgrgid().)

It defines the following items:

grp.getgrgid(gid)

Return the group database entry for the given numeric group ID.KeyErroris raised if the entry asked for cannot be found.

grp.getgrnam(name)

Return the group database entry for the given group name.KeyError israised if the entry asked for cannot be found.

grp.getgrall()

Return a list of all available group entries, in arbitrary order.

See also

Modulepwd
An interface to the user database, similar to this.
Modulespwd
An interface to the shadow password database, similar to this.