tinydb

Liens rapides

• Exemple de code
• Versions Python prises en charge
• Documentation
• Journal des modifications
• Rallonges
• Contribuer

Introduction

TinyDB est une base de données légère orientée document optimisée pour votre bonheur :) Elle est écrite en Python pur et n'a aucune dépendance externe. La cible sont les petites applications qui seraient époustouflées par une base de données SQL ou un serveur de base de données externe.

TinyDB est :

• tiny : le code source actuel comporte 1 800 lignes de code (avec environ 40 % de documentation) et 1 600 lignes de tests.
• orienté document : comme MongoDB, vous pouvez stocker n'importe quel document (représenté par dict ) dans TinyDB.
• optimisé pour votre bonheur : TinyDB est conçu pour être simple et amusant à utiliser en fournissant une API simple et propre.
• écrit en Python pur : TinyDB n'a besoin ni d'un serveur externe (comme par exemple PyMongo) ni de dépendances de PyPI.
• fonctionne sur Python 3.8+ et PyPy3 : TinyDB fonctionne sur toutes les versions modernes de Python et PyPy.
• puissamment extensible : vous pouvez facilement étendre TinyDB en écrivant de nouveaux stockages ou en modifiant le comportement des stockages avec des Middlewares.
• Couverture des tests à 100 % : aucune explication nécessaire.

Pour plonger directement dans tous les détails, rendez-vous sur la documentation TinyDB. Vous pouvez également discuter de tout ce qui concerne TinyDB, comme le développement général, les extensions, ou présenter vos projets basés sur TinyDB sur le forum de discussion.

Versions Python prises en charge

TinyDB a été testé avec Python 3.8 - 3.13 et PyPy3.

Statut du projet

Ce projet est en mode maintenance. Il a atteint un état mature et stable dans lequel aucune nouvelle fonctionnalité ou modification architecturale significative n’est prévue. Cela dit, il y aura toujours des versions pour des corrections de bugs ou des fonctionnalités apportées par la communauté. Apprenez-en davantage sur ce que cela signifie en particulier ici.

Exemple de code

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

Langage de requête

 > >> 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)

Tableaux

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

Utiliser des middlewares

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

Contribuer

Qu'il s'agisse de signaler des bugs, de discuter d'améliorations et de nouvelles idées ou d'écrire des extensions : les contributions à TinyDB sont les bienvenues ! Voici comment commencer :

1. Recherchez les problèmes ouverts ou ouvrez un nouveau problème pour démarrer une discussion autour d'une idée de fonctionnalité ou d'un bogue.
2. Forkez le référentiel sur Github, créez une nouvelle branche à partir de la branche principale et commencez à apporter vos modifications (connue sous le nom de GitHub Flow)
3. Écrivez un test qui montre que le bug a été corrigé ou que la fonctionnalité fonctionne comme prévu
4. Envoyez une pull request et buggez le responsable jusqu'à ce qu'il soit fusionné et publié ☺