Python | os.getgrouplist() method

OS module in Python provides functions for interacting with the operating system. OS comes under Python’s standard utility modules. This module provides a portable way of using operating system dependent functionality.

All functions in os module raise OSError in the case of invalid or inaccessible file names and paths, or other arguments that have the correct type, but are not accepted by the operating system.

In UNIX-like systems, multiple users can be put into a group. A group identifier, often abbreviated to GID, is a numeric value used to represent a specific group. It associates a system user with other users sharing something in common.

os.getgrouplist() method in Python is used to get the list of all group ids that the specified user belongs to.

Note: os.getgrouplist() method is only available on UNIX platforms.

Syntax: os.getgrouplist(user, gid)

Parameters:
user: A string value representing a system user.
gid: An integer value representing a group id.
If gid does not belong to the specified user, it will also be included in the return list

Return Type: This method returns a list which represents all group ids that the specified user belongs to.

Code: Use of os.getgrouplist() method

# Python program to explain os.getgrouplist() method

# importing os module
import os

# System user
user = "ihritik"

# Group id
gid = 100

# Get the list of all
# group ids the specified user
# belongs to using
# os.getgrouplist() method
groupList = os.getgrouplist(user, gid)

# Print the list
print("% s is associated with the following group ids:" % user)
print(groupList, "\n")


# System user
user = "root"

# Group id
gid = 100

# Get the list of all
# group ids the specified user
# belongs to using
# os.getgrouplist() method
groupList = os.getgrouplist(user, gid)

# Print the list
print("%s is associated with the following group ids:" %user)
print(groupList)


# If the specified gid does not
# belongs to the specified user
# it will also be included in
# the list of groups

Output:

ihritik is associated with the following group ids:
[100, 4, 24, 27, 30, 46, 118, 128] 

root is associated with the following group ids:
[100]