PyDbLite

From c3f4bf3112cfe038b68ad1f068085c0d51e5da54 Mon Sep 17 00:00:00 2001 From: LukenShiro Date: Wed, 12 May 2010 17:38:49 +0200 Subject: development/pydblite: Updated for version 2.3 --- development/pydblite/README | 4 + development/pydblite/index.html | 207 +++++++++++++++++++++++++++++++ development/pydblite/index_fr.html | 148 ++++++++++++++++++++++ development/pydblite/pydblite.SlackBuild | 12 +- development/pydblite/pydblite.info | 8 +- development/pydblite/slack-desc | 4 +- 6 files changed, 371 insertions(+), 12 deletions(-) create mode 100644 development/pydblite/index.html create mode 100644 development/pydblite/index_fr.html (limited to 'development/pydblite') diff --git a/development/pydblite/README b/development/pydblite/README index d315119df56b0..1038a7032a03d 100644 --- a/development/pydblite/README +++ b/development/pydblite/README @@ -3,3 +3,7 @@ PyDbLite (small footprint untyped database engine in python) PyDbLite is a pure-Python in-memory database engine, using Python list comprehensions as query language instead of SQL, which stores data in a cPickled file. + +You can also use PyDbLite with MySQL and SQLite, as backends. +In order to use MySQL's adapter you will need MySQL-python +(available on SlackBuilds.org). diff --git a/development/pydblite/index.html b/development/pydblite/index.html new file mode 100644 index 0000000000000..a7a7ccc6ca7c1 --- /dev/null +++ b/development/pydblite/index.html @@ -0,0 +1,207 @@ + + + +PyDbLite + + + + + + + + +

PyDbLite is a pure-Python in-memory database engine, using Python list +comprehensions as query language, instead of SQL + +

It consists of one small module, PyDbLite.py. The package also provides two modules, +SQLite.py and MySQL.py. They use SQLite and MySQL backends with the +same Pythonic syntax as the pure-Python PyDbLite engine + +

To install the package, just download +it and install it by running >python setup.py install + +

Pure-Python engine

+ +

import class Base from module PyDbLite : from PyDbLite import Base + +
create a database instance, passing it a path in the file system : db = Base('dummy') + +
for a new database, define the field names : db.create('name','age','size') + +
You don't have to define the field types. PyDbLite will accept any value that +can be serialized by the cPickle module : strings, Unicode strings, integers, +floats, dates and datetimes (instances of the date and datetime classes in the datetime module), user-defined classes, etc + +
if the base exists, open it : db.open() + +
you can pass a parameter "mode" to the create() method, to specify what +you want to do if the base already exists in the file system +
- mode = "open" : db.create('name','age','size',mode="open") + + opens the database and ignores the field definition + +
- mode = "override" : db.create('name','age','size',mode="override") + + erases the existing base and creates a new one with the field definition + +
- if mode is not specified and the base already exists, an IOError is raised +
+ +
insert a new record +
- by keywords : db.insert(name='homer',age=23,size=1.84) + +
  If some fields are missing, they are initialized with the value None + +
- by positional arguments : db.insert('homer',23,1.84) + +
  The arguments must be provided in the same order as in the create() method +
+ +
save the changes on disk : db.commit() +
If you don't commit the changes, the insertion, deletion and update operations +will not be saved on disk. To return to the previous version, just +open() it again (this is equivalent to rollback in transactional +databases) + +
besides the fields passed to the create() method, an internal field called __id__ is added. It is a integer which is guaranteed to be unique and unchanged for each record in the base, so that it can be used as the record identifier + +
another internal field called __version__ is also managed by the database engine. It is a integer which is set to 0 when the record is created, then incremented by 1 each time the record is updated. This is used to detect concurrency control, for instance in a web application where 2 users select the same record and want to update it at the same time + +
the selection of records uses Python list comprehension syntax : +
recs = [ r for r in db if 30 > r['age'] >= 18 and r['size'] < 2 ] + +
returns the records in the base where the age is between 18 and 30, and size is below 2 meters. The record is a dictionary, where the key is the field name and value is the field value + +
Python generator expression syntax can also be used : +
for r in (r for r in db if r['name'] in ('homer','marge') ):
+ do_something_with(r) + +
iterates on the records where the name is one of 'homer' or 'marge' + +
to iterate on all the records : +
for r in db:
+ do_something_with(r) + +
a record can be accessed by its identifier : record = db[rec_id] + +returns the record such that record['__id__'] == rec_id + +
finally, a shortcut can be used for simple selections : +db(key1=val1,key2=val2) returns the list of records where the keys take the given value. It is equivalent to [ r for r in db if r["key1"]==val1 and r["key2"]==val2], but much more concise + +
to speed up selections, an index can be created on a field : db.create_index('age') + +
When an index is created, the database instance has an attribute (here _age : note the heading underscore, to avoid name conflicts with internal names). This attribute is a dictionary-like object, where keys are the values taken by the field, and values are the records whose field values are egal to the key : +
records = db._age[23] returns the list of records with age == 23 + +
If no record has this value, lookup by this value returns an empty list + +
The index supports iteration on the field values, and the keys() method +returns all existing values for the field + +
number of records in the base : len(db) + +
to delete a record : db.delete(record) or, if you know the record identifier : del db[rec_id] + +
to delete a list of records : db.delete(list_of_records) + +
list_of_records can be any iterable (list, tuple, set, etc) yielding records + +
to update a record : db.update(record,age=24) + +
to add a new field to an existing base and specify a default value : db.add_field('new_field'[,default=v]). If no default is provided, the field value is None + +
to drop an existing field : db.drop_field('name') + +
to get the list of fields : db.fields + +

+ +

SQLite adapter

The only difference with the pure-Python module is the syntax to identify a Base and the need to specify field types on base creation +

import the class Base : +from PyDbLite.SQLite import Base +
connect to the SQLite database : +connection = sqlite.connect("test") +
to create a Base instance (a table in the SQLite database) you pass the connection as argument : db = Base('dummy',connection) +
to create the base you must specify an SQLite field type : NULL, INTEGER, REAL, TEXT +or BLOB : db.create(('name','TEXT'),('age',"INTEGER'),('size','REAL')) +
For convenience, you can also use the types DATE and DATETIME (or TIMESTAMP), the package will +transparently manage the conversions between the datetime.date and +datetime.datetime and the TEXT type +

For record insertion, selection, update and deletion, the syntax is the same as above. The only difference is that you can't use the drop_field() method, since dropping fields is not supported by SQLite +

The Base instance has an attribute cursor, so you can also execute +SQL expressions by db.cursor.execute(some_sql) and get the result +by results = db.cursor.fetchall() + +

MySQL adapter

The only difference with the pure-Python module is the syntax to identify a Base and the need to specify field types on base creation +

import the class Base : +from PyDbLite.MySQL import Base +
connect to the SQLite database : +
import MySQLdb
+ connection = MySQLdb.connect("localhost","root","admin")
+ connection.cursor().execute("USE test") + + +
pass the connection as argument to Base creation : db = Base('dummy',connection) +
to create a new base (a table in the MySQL database),specify a valid MySQL field type : +db.create(('name','INTEGER'),('age',"INTEGER'),('size','REAL')) +

+ +

For record insertion, selection, update and deletion, adding or dropping fields, +the syntax is the same as above +

The Base instance has an attribute cursor, so you can also execute +SQL expressions by db.cursor.execute(some_sql) and get the result +by results = db.cursor.fetchall() + + + + \ No newline at end of file diff --git a/development/pydblite/index_fr.html b/development/pydblite/index_fr.html new file mode 100644 index 0000000000000..112dabc8ff31e --- /dev/null +++ b/development/pydblite/index_fr.html @@ -0,0 +1,148 @@ + + + +PyDbLite + + + + + + + + +
PyDbLite English
+

PyDbLite est un moteur de base de données en mémoire, en pur Python, qui utilise les "list comprehensions" de Python comme langage de requêtes au lieu de SQL + +

Il consiste en un seul petit module, PyDbLite.py. Pour l'installer, il suffit de le télécharger et de le mettre dans le répertoire Lib/site-packages de votre distribution Python + +

Utilisation : + +

importer la classe Base du module PyDbLite : from PyDbLite import Base + +
créer une instance de base de données,en passant un nom de fichier : db = Base('test') + +
pour une nouvelle base, définissez les noms des champs : db.create('nom','age','taille') + +
Vous n'avez pas à définir le type des champs. PyDbLite accepte toute valeur qui peut être sérialisée par le module cPickle : des chaînes de caractères, des chaînes Unicode, des entiers, réels, dates et dates-heures (instances des classes date et datetime dans le module datetime), des instances de classes définies par l'utilisateur, etc + +
si la base existe déjà, pour l'ouvrir : db.open() + +
on peut passer un paramètre "mode" à la méthode create(), pour indiquer ce qu'il faut faire si la base existe déjà sur le disque +
- mode = "open" : db.create('nom','age','taille',mode="open") + +ouvre la base en ignorant la définition des champs + +
- mode = "override" : db.create('nom','age','taille',mode="override") + +efface la base existante et en crée une nouvelle avec les définitions de champs +
- si le mode n'est pas précisé et que la base existe déjà, une exception IOError est déclenchée
+ +
insertion d'un nouvel enregistrement +
- par mots-clés : db.insert(nom='homer',age=23,taille=1.84) + +
  Si certains champs manquent, ils sont initialisés à la valeur None + +
- par arguments positionnels : db.insert('homer',23,1.84) + +
  Les arguments doivent être fournis dans le même ordre que dans la méthode create() +
+ +
pour sauvegarder les changements sur le disque : db.commit() +
Si vous ne confirmez pas les changements, les opérations d'insertion, de suppression et de mise à jour ne seront pas sauvegardés sur le disque + +
En plus des champs passés à la méthode create(), un champ interne appelé __id__ est ajouté. C'est un entier, unique et inchangé pour chaque enregistrement, il peut donc être utilisé comme identifiant pour l'enregistrement + +
un autre champ interne appelé __version__ est également géré par le moteur de base de données. Il s'agit d'un entier qui est initialisé à 0 quand l'enregistrement est créé, et incrémenté de 1 à chaque fois que l'enregistrement est mis à jour. Ceci sert pour la détection des accès concurrents, par exemple dans une application web dans laquelle deux utilisateurs veulent mettre à jour le même enregistrement en même temps + +
la sélection d'enregistrements utilise la syntaxe des "list comprehensions" de Python : +
recs = [ r for r in db if 30 > r['age'] >= 18 and r['taille'] < 2 ] + +
retourne les enregistrements de la base pour lesquels l'âge est compris entre 18 et 30 ans, et la taille est inférieure à 2 mètres. L'enregistrement est un dictionnaire, où la clé est le nom de champ et la valeur est la valeur de ce champ + +
la syntaxe des générateurs d'expression Python peut aussi être utilisée : +
for r in (r for r in db if r['nom'] in ('homer','marge') ):
+ faire_qqch_avec(r) + +
itère sur les enregistrements dont le nom est 'homer' ou 'marge' + +
pour itérer sur tous les enregistrements : +
for r in db:
+ fais_qqch_avec(r) + +
on peut accéder directement à un enregistrement par son identifiant : record = db[rec_id] + +retourne l'enregistrement tel que record['__id__'] == rec_id + +
finalement, un raccourci peut être utilisé pour les sélections simples : +db(cle1=val1,cle2=val2) renvoie la liste des enregistrements dont les clés prennent les valeurs données. C'est équivalent à [ r for r in db if r["cle1"]==val1 and r["cle2"]==val2], mais en beaucoup plus concis + +
pour accélérer les sélections, un index peut être créé sur un champ : db.create_index('age') + +
Quand un index est créé, l'instance de la base de données a un attribut (ici _age : noter le signe de soulignement initial, pour éviter les conflits de noms avec des noms internes). Cet attribut est un objet de type dictionnaire, où les clés sont les valeurs prises par le champ, et les valeurs sont les enregistrements dont le champ a la même valeur que la clé : +
records = db._age[23] retourne la liste des enregistrements avec age == 23 + +
Si aucun enregistrement n'a cette valeur, la recherche par cette valeur retourne une liste vide + +
L'index supporte l'itération sur les valeurs du champ, et la méthode keys() retourne toutes les valeurs existantes pour le champ + +
nombre d'enregistrements dans la base : len(db) + +
pour supprimer un enregistrement : db.delete(record) ou, si vous connaissez l'identifiant : del db[rec_id] + +
pour supprimer une liste d'enregistrements : db.delete(liste_d_enregistrements) + +
liste_d_enregistrements peut être n'importe quel itérable (liste, tuple, set, etc) qui produit des enregistrements + +
pour mettre à jour un enregistrement : db.update(record,age=24) + +
pour ajouter un nouveau champ à une base existante et spécifier une valeur par défaut : db.add_field('nouveau_champ'[,default=v]). Si le défaut n'est pas fourni, la valeur du champ est None + +
pour supprimer un champ existant : db.drop_field('nom') + +
pour connaître la liste des champs : db.fields + +

+ + + \ No newline at end of file diff --git a/development/pydblite/pydblite.SlackBuild b/development/pydblite/pydblite.SlackBuild index 8d1ac18a18852..b8acc776d42ad 100644 --- a/development/pydblite/pydblite.SlackBuild +++ b/development/pydblite/pydblite.SlackBuild @@ -2,7 +2,7 @@ # Slackware build script for pydblite -# Copyright 2007 LukenShiro +# Copyright 2007-8-9 LukenShiro # All rights reserved. # # Redistribution and use of this script, with or without modification, is @@ -23,9 +23,8 @@ # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. PRGNAM=pydblite -SRC_PRGNAM=PyDbLite -VERSION=2.1 -ARCH=${ARCH:-i486} +VERSION=${VERSION:-2.3} +ARCH=noarch BUILD=${BUILD:-1} TAG=${TAG:-_SBo} @@ -34,7 +33,8 @@ TMP=${TMP:-/tmp/SBo} PKG=$TMP/package-$PRGNAM OUTPUT=${OUTPUT:-/tmp} -DOCFILES="LICENCE.txt PKG-INFO $SRC_PRGNAM/doc/index.html $SRC_PRGNAM/doc/index_fr.html" +SRC_PRGNAM=PyDbLite +DOCFILES="PKG-INFO $CWD/index.html $CWD/index_fr.html" # SLKCFLAGS are not used @@ -46,7 +46,7 @@ cd $TMP rm -rf $SRC_PRGNAM-$VERSION unzip $CWD/$SRC_PRGNAM-$VERSION.zip cd $SRC_PRGNAM-$VERSION -#chown -R root:root . +chown -R root:root . chmod -R u+w,go+r-w,a-s . # Install .py source files diff --git a/development/pydblite/pydblite.info b/development/pydblite/pydblite.info index 4c9d984efa078..9957500047d97 100644 --- a/development/pydblite/pydblite.info +++ b/development/pydblite/pydblite.info @@ -1,8 +1,8 @@ PRGNAM="pydblite" -VERSION="2.1" +VERSION="2.3" HOMEPAGE="http://pydblite.sourceforge.net" -DOWNLOAD="http://downloads.sourceforge.net/pydblite/PyDbLite-2.1.zip" -MD5SUM="a9ae4fc68873d0d9641e06cdd3c24043" +DOWNLOAD="http://downloads.sourceforge.net/pydblite/PyDbLite-2.3.zip" +MD5SUM="b0bd2216f3667dced29f71dc879e18cb" MAINTAINER="LukenShiro" EMAIL="lukenshiro@ngi.it" -APPROVED="rworkman" +APPROVED="dsomero" diff --git a/development/pydblite/slack-desc b/development/pydblite/slack-desc index aef7a48382682..f67cc73aa87ca 100644 --- a/development/pydblite/slack-desc +++ b/development/pydblite/slack-desc @@ -5,7 +5,7 @@ # make exactly 11 lines for the formatting to be correct. It's also # customary to leave one space after the ':'. - |-----handy-ruler------------------------------------------------------| + |-----handy-ruler------------------------------------------------------| pydblite: PyDbLite (small footprint untyped database engine in python) pydblite: pydblite: PyDbLite is a pure-Python in-memory database engine, using @@ -14,6 +14,6 @@ pydblite: which stores data in a cPickled file. pydblite: pydblite: It is written by Pierre Quentel and released under BSD license. pydblite: -pydblite: http://pydblite.sourceforge.net pydblite: +pydblite: Homepage: http://pydblite.sourceforge.net pydblite: -- cgit v1.2.3