tinydb

Быстрые ссылки

• Пример кода
• Поддерживаемые версии Python
• Документация
• Журнал изменений
• Расширения
• Содействие

Введение

TinyDB — это легкая документо-ориентированная база данных, оптимизированная для вашего удобства :) Она написана на чистом Python и не имеет внешних зависимостей. Целью являются небольшие приложения, которые могут быть уничтожены SQL-DB или внешним сервером базы данных.

TinyDB — это:

• крошечный: текущий исходный код содержит 1800 строк кода (около 40% документации) и 1600 строк тестов.
• ориентированность на документы: как и MongoDB, вы можете хранить любой документ (представленный как dict ) в TinyDB.
• оптимизировано для вашего счастья: TinyDB спроектирован так, чтобы его было просто и интересно использовать, поскольку он предоставляет простой и понятный API.
• написан на чистом Python: TinyDB не нуждается ни во внешнем сервере (как, например, PyMongo), ни в каких-либо зависимостях от PyPI.
• работает на Python 3.8+ и PyPy3: TinyDB работает на всех современных версиях Python и PyPy.
• мощная расширяемость: вы можете легко расширить TinyDB, написав новые хранилища или изменив поведение хранилищ с помощью промежуточного программного обеспечения.
• 100% тестовое покрытие: пояснений не требуется.

Чтобы погрузиться во все детали, перейдите к документации TinyDB. Вы также можете обсудить все, что связано с TinyDB, например, общие разработки, расширения или продемонстрировать свои проекты на основе TinyDB на дискуссионном форуме.

Поддерживаемые версии Python

TinyDB был протестирован с Python 3.8–3.13 и PyPy3.

Статус проекта

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

Пример кода

 > >> from tinydb import TinyDB , Query
> >> db = TinyDB ( '/path/to/db.json' )
> >> db . insert ({ 'int' : 1 , 'char' : 'a' })
> >> db . insert ({ 'int' : 1 , 'char' : 'b' })

Язык запросов

 > >> User = Query ()
> >> # Search for a field value
>> > db . search ( User . name == 'John' )
[{ 'name' : 'John' , 'age' : 22 }, { 'name' : 'John' , 'age' : 37 }]

> >> # Combine two queries with logical and
>> > db . search (( User . name == 'John' ) & ( User . age <= 30 ))
[{ 'name' : 'John' , 'age' : 22 }]

> >> # Combine two queries with logical or
>> > db . search (( User . name == 'John' ) | ( User . name == 'Bob' ))
[{ 'name' : 'John' , 'age' : 22 }, { 'name' : 'John' , 'age' : 37 }, { 'name' : 'Bob' , 'age' : 42 }]

> >> # Negate a query with logical not
>> > db . search ( ~ ( User . name == 'John' ))
[{ 'name' : 'Megan' , 'age' : 27 }, { 'name' : 'Bob' , 'age' : 42 }]

> >> # Apply transformation to field with `map`
>> > db . search (( User . age . map ( lambda x : x + x ) == 44 ))
> >> [{ 'name' : 'John' , 'age' : 22 }]

> >> # More possible comparisons:  !=  <  >  <=  >=
>> > # More possible checks: where(...).matches(regex), where(...).test(your_test_func)

Таблицы

 > >> table = db . table ( 'name' )
> >> table . insert ({ 'value' : True })
> >> table . all ()
[{ 'value' : True }]

Использование промежуточного программного обеспечения

 > >> from tinydb . storages import JSONStorage
> >> from tinydb . middlewares import CachingMiddleware
> >> db = TinyDB ( '/path/to/db.json' , storage = CachingMiddleware ( JSONStorage ))

Содействие

Сообщайте об ошибках, обсуждайте улучшения и новые идеи или напишите расширения: вклад в TinyDB приветствуется! Вот как начать:

1. Проверьте наличие открытых проблем или откройте новую проблему, чтобы начать обсуждение идеи функции или ошибки.
2. Создайте форк репозитория на Github, создайте новую ветку на основе основной ветки и начните вносить изменения (известный как GitHub Flow).
3. Напишите тест, который покажет, что ошибка исправлена ​​или что функция работает должным образом.
4. Отправьте запрос на включение и исправьте ошибки у сопровождающего, пока он не будет объединен и опубликован ☺