Валидатор данных

Цель

Валидатор данных – проект, направленный на прокачку проектирования архитектуры в объектно-ориентированном стиле. Здесь вам понадобится применять практически все, чему вы научились в курсах по ООП: проектирование структуры классов, композиция объектов, возможно наследование и, обязательно, fluent-интерфейс. Вам придется задумываться о глобальном и локальном состоянии, думать о расширяемости кода без его переписывания, соблюдать SOLID принципы.

Описание

Валидатор данных – библиотека, с помощью которой можно проверять корректность любых данных. Подобных библиотек множество в каждом языке, так как практически все программы работают с внешними данными, которые нужно проверять на корректность. В первую очередь речь идет про данные форм заполняемых пользователями. За основу для проекта взята библиотека yup.

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

from validator import Validator

v = Validator()

# строки
schema = v.string().required()

schema.is_valid('what does the fox say') # True
schema.is_valid('') # False

# числа
schema = v.number().required().positive()

schema.is_valid(-10) # False
schema.is_valid(10) # True

# списки
schema = v.list().sizeof(2)

schema.is_valid(['java', 'python']) # True
schema.is_valid(['java']) # False

# словарь с поддержкой проверки структуры
schema = v.dict().shape({
    'name': v.string().required(),
    'age': v.number().positive(),
})

schema.is_valid({'name': 'kolya', 'age': 100}) # True
schema.is_valid({'name': '', 'age': None}) # False

# добавление нового валидатора
fn = lambda value, start: value.startswith(start)
v.add_validator('string', 'startWith', fn)

schema = v.string().test('startWith', 'H')

schema.is_valid('exlet') # False
schema.is_valid('Hexlet') # True

Предметно-ориентированные языки (DSL)

Интерфейс библиотеки для валидации – яркий пример DSL, специализированного языка, позволяющего декларативно (описательно) описывать то, что вы хотите от кода. Код, написанный в таком стиле, читается значительно легче, чем работа с прямым созданием объектов. Во многом этот подход базируется на паттерне fluent-интерфейс.

Архитектура

Ключевая часть внутренней архитектуры – организация валидаторов. Эту задачу можно решить множеством разных способов, но только некоторые из них дают по-настоящему удобную и расширяемую структуру без излишней сложности. Проектируя архитектуру, крайне легко перестараться и сделать что-то очень сложное.

Как и любая взрослая библиотека для валидации – наш проект поддерживает расширяемость через добавление новых правил проверок. Это довольно важное архитектурное решение, от которого зависит, насколько код будет удобным в сопровождении и простым в работе.

Тестирование и Отладка

Автоматизированные тесты – неотъемлемая часть профессиональной разработки. Валидатор данных – идеальный проект для прокачки навыка тестирования. Он достаточно простой и удобный для написания тестов, и достаточно сложный для того, чтобы прочувствовать важность этих тестов во время рефакторинга и отладки. В отличие от практики Хекслета, здесь предстоит писать тесты самостоятельно. Причем это можно делать до кода, практикуя TDD.

Для написания тестов используется фреймворк pytest