healthsciencecalculator.get_bmi

Classes

BMIResult

Functions

get_bmi(→ BMIResult)

Calculate Body Mass Index (BMI) and return detailed classification information.

Module Contents

class healthsciencecalculator.get_bmi.BMIResult

bmi: float

category: str

healthsciencecalculator.get_bmi.get_bmi(weight: float, height: float) → BMIResult

Calculate Body Mass Index (BMI) and return detailed classification information.

BMI is calculated as weight (kg) divided by height (m) squared.

Parameters:

• weight (float) – Weight in kilograms

• height (float) – Height in meters

Returns:

A dataclass containing: - bmi (float): The calculated BMI value - category (str): BMI category, one of:

• ’underweight’ (BMI < 18.5)

• ’healthy’ (BMI 18.5-24.9)

• ’overweight’ (BMI 25-29.9)

• ’class 1 obesity’ (BMI 30-34.9)

• ’class 2 obesity’ (BMI 35-39.9)

• ’class 3 obesity’ (BMI >= 40)

Return type:

BMIResult

Example

>>> get_bmi(weight=70.0, height=1.75)
BMIResult(bmi=22.9, category='healthy')

Raises:

• ValueError – If weight or height is not positive

• TypeError – If weight or height is not a number