Building a Home Loan Calculator in Python

A home loan calculator is a useful programming project for practising input validation, arithmetic, functions and formatted output.

This tutorial demonstrates a simplified repayment calculator using Python. It estimates a regular monthly repayment for a loan with a fixed interest rate and monthly repayments.

The Formula

For a standard amortising loan, the monthly repayment can be calculated using:

[
M = \frac{P r(1+r)^n}{(1+r)^n-1}
]

Where:

(M) is the monthly repayment.
(P) is the principal loan amount.
(r) is the monthly interest rate expressed as a decimal.
(n) is the total number of monthly repayments.

The annual interest rate is divided by 12 and converted from a percentage into a decimal.

Python Implementation

def calculate_monthly_repayment(
    principal, annual_rate, years
):
    if principal <= 0:
        raise ValueError("Principal must be positive.")

    if annual_rate < 0:
        raise ValueError("Interest rate cannot be negative.")

    if years <= 0:
        raise ValueError("Loan term must be positive.")

    months = years * 12
    monthly_rate = annual_rate / 100 / 12

    if monthly_rate == 0:
        return principal / months

    factor = (1 + monthly_rate) ** months

    return principal * monthly_rate * factor / (factor - 1)


try:
    principal = float(input("Loan amount: "))
    annual_rate = float(input("Annual interest rate (%): "))
    years = int(input("Loan term (years): "))

    repayment = calculate_monthly_repayment(
        principal, annual_rate, years
    )

    print(f"Estimated monthly repayment: ${repayment:,.2f}")

except ValueError as error:
    print(f"Invalid input: {error}")

How the Code Works

The function validates the loan amount, interest rate and term before performing the calculation.

It converts the annual rate into a monthly decimal rate and calculates the number of monthly repayments. If the interest rate is zero, it divides the principal equally across the repayment period.

Otherwise, it applies the amortisation formula to estimate the monthly repayment.

Testing the Calculator

Try different loan amounts, rates and terms. Check that increasing the interest rate generally increases the repayment, while extending the term generally reduces the regular repayment but may increase the total interest paid.

Important Limitations

This is an educational example. It assumes a constant interest rate and regular monthly repayments. It does not account for fees, offset accounts, redraw facilities, changing rates or lender-specific repayment rules.

Real loan products can differ substantially, so the output should not be treated as a lender quotation or personal financial advice.

Conclusion

This project demonstrates how mathematical formulas can be converted into reusable Python functions. It can be extended with a graphical interface, an amortisation schedule, unit tests or a chart of the remaining balance over time.

DEV Community