You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
3.9 KiB
119 lines
3.9 KiB
'''
|
|
Elixir package
|
|
|
|
A declarative layer on top of the `SQLAlchemy library
|
|
<http://www.sqlalchemy.org/>`_. It is a fairly thin wrapper, which provides
|
|
the ability to create simple Python classes that map directly to relational
|
|
database tables (this pattern is often referred to as the Active Record design
|
|
pattern), providing many of the benefits of traditional databases
|
|
without losing the convenience of Python objects.
|
|
|
|
Elixir is intended to replace the ActiveMapper SQLAlchemy extension, and the
|
|
TurboEntity project but does not intend to replace SQLAlchemy's core features,
|
|
and instead focuses on providing a simpler syntax for defining model objects
|
|
when you do not need the full expressiveness of SQLAlchemy's manual mapper
|
|
definitions.
|
|
'''
|
|
|
|
try:
|
|
set
|
|
except NameError:
|
|
from sets import Set as set
|
|
|
|
import sqlalchemy
|
|
from sqlalchemy.types import *
|
|
|
|
from elixir.options import using_options, using_table_options, \
|
|
using_mapper_options, options_defaults, \
|
|
using_options_defaults
|
|
from elixir.entity import Entity, EntityBase, EntityMeta, EntityDescriptor, \
|
|
setup_entities, cleanup_entities
|
|
from elixir.fields import has_field, Field
|
|
from elixir.relationships import belongs_to, has_one, has_many, \
|
|
has_and_belongs_to_many, \
|
|
ManyToOne, OneToOne, OneToMany, ManyToMany
|
|
from elixir.properties import has_property, GenericProperty, ColumnProperty, \
|
|
Synonym
|
|
from elixir.statements import Statement
|
|
from elixir.collection import EntityCollection, GlobalEntityCollection
|
|
|
|
|
|
__version__ = '0.7.1'
|
|
|
|
__all__ = ['Entity', 'EntityBase', 'EntityMeta', 'EntityCollection',
|
|
'entities',
|
|
'Field', 'has_field',
|
|
'has_property', 'GenericProperty', 'ColumnProperty', 'Synonym',
|
|
'belongs_to', 'has_one', 'has_many', 'has_and_belongs_to_many',
|
|
'ManyToOne', 'OneToOne', 'OneToMany', 'ManyToMany',
|
|
'using_options', 'using_table_options', 'using_mapper_options',
|
|
'options_defaults', 'using_options_defaults',
|
|
'metadata', 'session',
|
|
'create_all', 'drop_all',
|
|
'setup_all', 'cleanup_all',
|
|
'setup_entities', 'cleanup_entities'] + \
|
|
sqlalchemy.types.__all__
|
|
|
|
__doc_all__ = ['create_all', 'drop_all',
|
|
'setup_all', 'cleanup_all',
|
|
'metadata', 'session']
|
|
|
|
# default session
|
|
session = sqlalchemy.orm.scoped_session(sqlalchemy.orm.sessionmaker())
|
|
|
|
# default metadata
|
|
metadata = sqlalchemy.MetaData()
|
|
|
|
metadatas = set()
|
|
|
|
# default entity collection
|
|
entities = GlobalEntityCollection()
|
|
|
|
|
|
def create_all(*args, **kwargs):
|
|
'''Create the necessary tables for all declared entities'''
|
|
for md in metadatas:
|
|
md.create_all(*args, **kwargs)
|
|
|
|
|
|
def drop_all(*args, **kwargs):
|
|
'''Drop tables for all declared entities'''
|
|
for md in metadatas:
|
|
md.drop_all(*args, **kwargs)
|
|
|
|
|
|
def setup_all(create_tables=False, *args, **kwargs):
|
|
'''Setup the table and mapper of all entities in the default entity
|
|
collection.
|
|
|
|
This is called automatically if any entity of the collection is configured
|
|
with the `autosetup` option and it is first accessed,
|
|
instanciated (called) or the create_all method of a metadata containing
|
|
tables from any of those entities is called.
|
|
'''
|
|
setup_entities(entities)
|
|
|
|
# issue the "CREATE" SQL statements
|
|
if create_tables:
|
|
create_all(*args, **kwargs)
|
|
|
|
|
|
def cleanup_all(drop_tables=False, *args, **kwargs):
|
|
'''Clear all mappers, clear the session, and clear all metadatas.
|
|
Optionally drops the tables.
|
|
'''
|
|
session.close()
|
|
|
|
cleanup_entities(entities)
|
|
|
|
sqlalchemy.orm.clear_mappers()
|
|
entities.clear()
|
|
|
|
if drop_tables:
|
|
drop_all(*args, **kwargs)
|
|
|
|
for md in metadatas:
|
|
md.clear()
|
|
metadatas.clear()
|
|
|
|
|
|
|