`locals()` Function in Python [ English ]

Languages

• English

1. Introduction

The locals() function in Python is a built-in function used to return a dictionary containing the current local symbol table. In simple terms, it provides a mapping of all local variables and their values within the current scope.

Local variables are variables that are defined inside a function or a specific block of code. The locals() function allows programmers to inspect these variables and their current values during program execution.

2. Syntax

locals()

Parameters

• The locals() function does not take any parameters.

Return Value

• Returns a dictionary containing all local variables and their values in the current scope.

3. Example in Global Scope

a = 10
b = 20

print(locals())

Output (example)

{'a': 10, 'b': 20, '__name__': '__main__', '__builtins__': {...}}

Explanation

• Since the variables a and b are defined in the current scope, they appear in the dictionary returned by locals().

4. Example Inside a Function

def display():
    x = 5
    y = 10
    print(locals())

display()

Output

{'x': 5, 'y': 10}

Explanation

• The variables x and y are local to the function display().
• locals() returns a dictionary showing these variables and their values.

5. Accessing Local Variables from the Dictionary

The dictionary returned by locals() can be used to access values of local variables.

def example():
    a = 3
    b = 7

    local_vars = locals()
    print(local_vars['a'])
    print(local_vars['b'])

example()

Output

3
7

Explanation

• locals() returns a dictionary stored in local_vars.
• The values of variables a and b are accessed using dictionary keys.

6. Practical Example

def student():
    name = "Rahul"
    age = 20
    course = "BCA"

    print(locals())

student()

Output

{'name': 'Rahul', 'age': 20, 'course': 'BCA'}

Explanation

• The function contains three local variables: name, age, and course.
• locals() returns them as key-value pairs in a dictionary.

7. Difference Between locals() and globals()

Example:

x = 100

def test():
    y = 50
    print("Local:", locals())
    print("Global:", globals())

test()

8. Uses of locals()

The locals() function is useful for:

• Inspecting variables inside a function
• Debugging programs
• Understanding variable scope
• Dynamic variable handling

9. Summary

• locals() is a built-in Python function.
• It returns a dictionary of all local variables in the current scope.
• It does not require any arguments.
• It is commonly used for debugging and inspecting variables inside functions.