Detecting and Resolving Module Conflicts in Python

---
description: Detect and resolve module conflicts in Python projects to ensure smooth dependency management.
globs: "**/*.py"
tags: [python, dependency-management, module-conflicts]
priority: 3
version: 1.0.0
---

# Detecting and Resolving Module Conflicts in Python

## Context
- Applicable to all Python projects.
- Aimed at identifying and resolving module conflicts that can disrupt dependency management.

## Requirements
- **Unique Module Naming**: Ensure all custom modules have unique names to prevent conflicts with standard libraries or third-party packages.
- **Absolute Imports**: Use absolute imports to avoid ambiguity and potential conflicts with modules of the same name.
- **Virtual Environments**: Utilize virtual environments to manage project-specific dependencies and isolate them from the global Python environment.
- **Dependency Specification**: Clearly specify all project dependencies in a `requirements.txt` or `pyproject.toml` file, including exact versions when necessary.
- **Regular Dependency Audits**: Periodically review and update dependencies to maintain compatibility and security.

## Examples

<example>
**Good Practice**: Using a unique module name and absolute import.

# File: my_project/utils.py
def helper_function():
    pass

# File: my_project/main.py
from my_project.utils import helper_function
In this example, `utils.py` is uniquely named within the `my_project` package, and `main.py` uses an absolute import to access `helper_function`, reducing the risk of conflicts.
</example>

<example type="invalid">
**Bad Practice**: Using a common module name that conflicts with a standard library.

# File: my_project/os.py
def custom_function():
    pass

# File: my_project/main.py
import os
os.custom_function()
Here, naming a module `os.py` conflicts with Python's standard `os` module, leading to potential import errors.
</example>