Geometric Lib Documentation

Общее описание решения

Geometric Lib — это библиотека на Python для вычисления основных геометрических характеристик простых фигур: круга, квадрата, прямоугольника и треугольника. Библиотека предоставляет функции для расчёта площади и периметра (или длины окружности) этих фигур, что упрощает выполнение геометрических вычислений в различных приложениях и учебных задачах.

Основные возможности библиотеки:

• Вычисление площади и периметра квадрата.
• Вычисление площади и длины окружности круга.
• Вычисление площади и периметра прямоугольника.
• Вычисление площади и периметра треугольника.

Описание функций с примерами вызова

Модуль circle.py

area(r)

Вычисляет площадь круга с радиусом r.

Параметры:

• r (float): Радиус круга.

Возвращает:

• float: Площадь круга.

Пример использования:

from circle import area

result = area(5)
print(result)  # Вывод: 78.53981633974483

perimeter(r)

Вычисляет длину окружности круга с радиусом r.

Параметры:

• r (float): Радиус круга.

Возвращает:

• float: Длина окружности.

Пример использования:

from circle import perimeter

result = perimeter(5)
print(result)  # Вывод: 31.41592653589793

Модуль square.py

area(a)

Вычисляет площадь квадрата со стороной a.

Параметры:

• a (float): Длина стороны квадрата.

Возвращает:

• float: Площадь квадрата.

Пример использования:

from square import area

result = area(4)
print(result)  # Вывод: 16

perimeter(a)

Вычисляет периметр квадрата со стороной a.

Параметры:

• a (float): Длина стороны квадрата.

Возвращает:

• float: Периметр квадрата.

Пример использования:

from square import perimeter

result = perimeter(4)
print(result)  # Вывод: 16

Модуль rectangle.py

area(a, b)

Вычисляет площадь прямоугольника с длиной a и шириной b.

Параметры:

• a (float): Длина прямоугольника.
• b (float): Ширина прямоугольника.

Возвращает:

• float: Площадь прямоугольника.

Пример использования:

from rectangle import area

result = area(5, 10)
print(result)  # Вывод: 50

perimeter(a, b)

Вычисляет периметр прямоугольника с длиной a и шириной b.

Параметры:

• a (float): Длина прямоугольника.
• b (float): Ширина прямоугольника.

Возвращает:

• float: Периметр прямоугольника.

Пример использования:

from rectangle import perimeter

result = perimeter(5, 10)
print(result)  # Вывод: 30

Модуль triangle.py

area(a, h)

Вычисляет площадь треугольника с основанием a и высотой h.

Параметры:

• a (float): Длина основания треугольника.
• h (float): Высота треугольника.

Возвращает:

• float: Площадь треугольника.

Пример использования:

from triangle import area

result = area(6, 4)
print(result)  # Вывод: 12.0

perimeter(a, b, c)

Вычисляет периметр треугольника со сторонами a, b и c.

Параметры:

• a (float): Длина первой стороны.
• b (float): Длина второй стороны.
• c (float): Длина третьей стороны.

Возвращает:

• float: Периметр треугольника.

Пример использования:

from triangle import perimeter

result = perimeter(3, 4, 5)
print(result)  # Вывод: 12

Автоматическое тестирование с GitHub Actions

Для обеспечения качества и стабильности кода, в проект был добавлен workflow для автоматического запуска unit тестов с использованием GitHub Actions. Это позволяет выполнять тесты автоматически после каждого push, проверяя корректность всех изменений.

История изменений проекта

• 34cfb5c Добавлен добавлен workflow для автоматического запуска unit тестов
• 28fa843 Созданы unit-тесты и добавлен файл test_report.md
• 0f0ccf1 Обновлён README.md для описания функций
• 62f810d Обновлён README.md для уточнений по функциям
• 41fe74a Обновлена функция area в triangle.py
• c60748e Обновлена функция area в square.py
• b62fee5 Обновлён rectangle.py, добавлены функции area и perimeter
• 4314e53 Обновлена функция perimeter в circle.py для исправления ошибки вычислений

Детали изменений

• Коммит 34cfb5c: Добавлен добавлен workflow для автоматического запуска unit тестов.
• Коммит 28fa843: Добавлены unit-тесты для всех функций библиотеки и создан файл test_report.md.
• Коммит 0f0ccf1: Обновлён README.md, добавлены примеры использования функций.
• Коммит 62f810d: Уточнено описание функций и примеры в README.md.
• Коммит 41fe74a: Обновлена функция вычисления площади треугольника area(a, h) в triangle.py.
• Коммит c60748e: Уточнена функция вычисления площади квадрата area(a) в square.py.
• Коммит b62fee5: Обновлён rectangle.py, добавлены функции area(a, b) и perimeter(a, b) для вычисления площади и периметра прямоугольника.
• Коммит 4314e53: Исправлена ошибка в функции perimeter для круга в модуле circle.py.