Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions maths/division.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
"""
This module provides a function for dividing two numbers with proper input validation.

The divide_numbers function includes validation to prevent division by zero errors,
providing clear error messages for better user experience.
"""


def divide_numbers(numerator: float, denominator: float) -> float:
"""
Divide two numbers with input validation for zero denominator.

Args:
numerator: The numerator (dividend)
denominator: The denominator (divisor)

Returns:
float: The result of numerator divided by denominator

Raises:
ValueError: If denominator is zero

Examples:
>>> divide_numbers(10, 2)
5.0
>>> divide_numbers(15, 3)
5.0
>>> divide_numbers(10, 0)
Traceback (most recent call last):
...
ValueError: Cannot divide by zero. Please provide a non-zero denominator.
"""
if denominator == 0:
raise ValueError(
"Cannot divide by zero. Please provide a non-zero denominator."
)
return numerator / denominator


if __name__ == "__main__":
import doctest

doctest.testmod()