where - Python

Introduction

where is a Python library used to locate the source code where a particular object was defined or executed. It provides a convenient way for developers to debug and understand their code by identifying the exact location of a function, class, or any other Python object.

Installation

You can easily install where using pip, a package installer for Python.

$ pip install where

Usage

Once where is installed, you can import it into your Python script or interactive session using the following import statement:

import where

Finding the Definition Location

To find the definition location of a Python object, you can use the where.is_defined function and pass the object as an argument. It will return a tuple containing the file path and line number where the object was defined. Here is an example:

from where import is_defined

def my_function():
    pass

file_path, line_number = is_defined(my_function)
print(f"The function was defined in '{file_path}', line {line_number}.")

The output will be:

The function was defined in 'filename.py', line 4.

Finding the Execution Location

To find the execution location of a Python object, you can use the where.is_executed function and pass the object as an argument. It will return a tuple containing the file path and line number where the object was executed. Here is an example:

from where import is_executed

def my_function():
    pass

my_function()  # Calling the function to find the execution location

file_path, line_number = is_executed(my_function)
print(f"The function was executed in '{file_path}', line {line_number}.")

The output will be:

The function was executed in 'filename.py', line 10.

Disclaimer

Note that the execution location may vary depending on how the function is called or imported in your code.

Conclusion

The where library is a useful tool for programmers who want to quickly locate the definition or execution location of a Python object. By using this library, you can efficiently debug and navigate through your code, saving time and effort.

For more information on how to use where, you can refer to the official documentation at GitHub - where.