Читаемость, аннотации и тесты

Дополнительный урок — для продвинутых. Он для тех, кто пишет программы, которые нужно поддерживать и проверять: в темах ЕГЭ аннотации и тесты не нужны, но приём «быстрое решение против медленного эталона» полезен и на экзамене. Задачи основных уроков решаются без него.

Программу из урока 7.1 ты проверял руками: запускал на обычном, пустом и испорченном файле и сверял вывод. После каждой правки всё это пришлось бы повторять. Код пишут так, чтобы его было легко прочитать и проверить: понятные имена, аннотации договорённости и тесты, которые проверяют программу за тебя.

Код должен объяснять задачу именами, константами и комментариями о причинах. Ясные имена, короткие функции и явные условия обычно полезнее сокращения числа строк. Имя count говорит о количестве, total — о сумме, best — о выбранном лучшем результате. Если рядом существуют максимум значения и максимум суммы пары, назови их по-разному.

Избегай магических чисел — необъяснённых констант. Если 86400 обозначает число секунд в сутках, имя SECONDS_PER_DAY делает смысл видимым. Заглавные буквы — соглашение о постоянном значении; Python не запрещает его изменить.

Комментарий должен объяснять решение, ограничение или причину. Комментарий «увеличиваем i» рядом с i += 1 обычно менее полезен, чем «левая граница больше не может дать допустимое окно».

Аннотация типа описывает ожидаемые данные, но Python её не проверяет. Её пишут после имени параметра и после ->:

def count_positive(numbers: list[int]) -> int:    return sum(number > 0 for number in numbers) print(count_positive([3, -1, 0, 5]))

После параметра стоит ожидаемый тип, после -> — тип результата. list[int] означает список целых. Логические значения в арифметике ведут себя как 0 и 1, поэтому сумма истинных сравнений считает их количество.

Python не проверяет эти аннотации при вызове. Для анализа без запуска используют отдельные инструменты проверки типов. Они помогают находить несоответствия, но не доказывают математическую правильность алгоритма.

def maximum_negative(numbers: list[int]) -> int | None:    best = None    for number in numbers:        if number < 0 and (best is None or number > best):            best = number    return best print(maximum_negative([5, -9, -2, 0]), maximum_negative([]))

int | None в Python 3.10+ означает один из двух вариантов результата. Это помогает помнить про отсутствие ответа.

Аннотация — часть описания договорённости. Проверку диапазона, запрет пустого входа и изменение аргументов часто надо описать отдельно в документации.

Модульный тест — программа, которая вызывает функцию и сравнивает результат с ожидаемым. Проверим summarize из урока 7.1. Тесты лежат в отдельном файле рядом с analyze_numbers.py и импортируют функцию, как check.py в том уроке:

import unittest from analyze_numbers import summarize  class SummarizeTests(unittest.TestCase):    def test_usual_numbers(self):        report = summarize([5, -2, 10, 7])        self.assertEqual(report["total"], 20)        self.assertEqual(report["maximum"], 10)     def test_one_number(self):        self.assertEqual(summarize([-5])["average"], -5.0)     def test_empty_list(self):        self.assertIsNone(summarize([])["maximum"])     def test_fractional_average(self):        self.assertEqual(summarize([1, 2])["average"], 1.5)  if __name__ == "__main__":    unittest.main()

Класс тестов наследует unittest.TestCase, как Task наследовал NamedItem в уроке о классах. Каждый метод с именем на test_ — отдельный тест. assertEqual(a, b) требует равенства, assertIsNone — значения None. Точка в выводе — пройденный тест, OK — все прошли; время прогона у тебя может быть другим. Запуск из терминала:

Тесты нужны ради момента, когда что-то сломалось. Допустим, при правке в summarize написали // вместо /:

        "average": total // len(numbers),

Вторая точка стала F: тест test_fractional_average упал. Ниже — строка теста и что не совпало: получили 1, ждали 1.5. Остальные три теста прошли — для них целое деление случайно дало верный ответ. Поэтому тесты подбирают так, чтобы каждый ловил свою ошибку, как в уроке об исключениях.

Быстрое решение проверяют медленным, но очевидным эталоном. Оптимизированный алгоритм может быть трудно проверить глазами. Для маленьких данных напиши очевидный полный перебор, затем сравнивай результаты. Медленный вариант здесь служит независимым образцом, поэтому желательно, чтобы он не повторял ту же самую хитрую логику.

Например, сумму цифр можно считать арифметикой, а эталон — прямо через запись числа:

import random def digit_sum(number):    number = abs(number)    total = 0    while number > 0:        total += number % 10        number //= 10    return total def digit_sum_slow(number):    return sum(int(c) for c in str(abs(number))) rng = random.Random(42)for _ in range(1000):    n = rng.randint(-10**6, 10**6)    assert digit_sum(n) == digit_sum_slow(n), nprint("совпадает на 1000 случайных числах")

Договорённость — целые числа любого знака.

При случайной генерации используй фиксированное начальное состояние генератора, например random.Random(42), чтобы ошибку можно было воспроизвести. Случайные тесты дополняют, а не заменяют специально выбранные границы: число 0 случайно может и не выпасть.

Иногда проверяют не ответ, а свойство, которое ему обязано принадлежать. После сортировки должны сохраниться количество и набор элементов с учётом повторов. Для перевода основания int(запись, base) от записи числа должно давать исходное число. Каждый найденный делитель обязан делить число без остатка, а список делителей должен содержать 1 и само положительное число.

from collections import Counter data = [5, 3, 5, -1, 0]result = sorted(data)ordered = all(a <= b for a, b in zip(result, result[1:]))print(ordered, Counter(result) == Counter(data))

Однако отдельное свойство может пропустить ошибку: список [1, n] содержит только настоящие делители, но не все. Поэтому проверяй и допустимость найденного, и полноту решения.