helper utility for repository pattern of PofEAA
Project description
rebecca.repository
An implementation of repository pattern for SQLAlchemy.
Getting Started
install by pip:
$ pip install rebecca.repository
Repository for SQLAlchemy
basic repository
Implement your model by SQLAlchemy:
from sqlalchemy import Column, Integer, Unicode from sqlalchemy.ext.declarative import declarative_base Base = declarative_base() DBSession = scoped_session(sessionmaker()) class Person(Base): __tablename__ = "person" id = Column(Integer, primary_key=True) name = Column(Unicode(255)) age = Column(Integer, default=0) job = Column(Unicode(255))
Get repository:
from rebecca.repository.sqla import SQLARepository person_repository = SQALRepository(Person, Person.id, DBSession())
this repository for Person model. To get person, use Person.id as key.
conditional repository
repository can configure to set condition:
person_repository = SQALRepository(Person, Person.id, DBSession(), condition=Person.age>30)
repository factory
If you pass the parameters during request time, use factory.
class JobPersonRepository(SQLARepository): def __init__(self, db_session, job): super(JobPersonRepository, self).__init__(Person, Person.id, dbsession, condition=Person.job==job)
The parameter job will be passed from request attribute.
To register repository factory, add_repository_factory directive:
config.add_repository_factory(JobPersonRepository, "job-person", args=(DBSession,))
or repository_factory_config decorator:
@repository_factory_config("job-person", args=(DBSession,)) class JobPersonRepository(SQLARepository): ....
To create repository from registered factory, call create_repository API:
job = request.matchdict["job"] repository = create_repository("person", args=(job,))
Repository for Filesystem
rebecca.repository.fs.FileSystemRepository is repository for FileSystem:
>>> repository = FileSystemRepository(directory="/path/to/data") >>> item = repository.new_item("new-item") >>> item.data = b"testing-binary-data" >>> import transaction >>> transaction.commit()
FileSystemRepository.new_item is create new file system entry. item.data is binary data that saved in the file. That’s transactional with transaction .
repository interface
create object for demonstration:
person1 = Person(name=u"person1") DBSession.add(person1) DBSession.flush() # to generate person.id
A repository has dict like interface:
person_repository[person.id] person_repository.get(person.id)
and utility methods:
person_repository.get_many([1, 2, 3]) new_person = person_repository.new_item()
pyramid integration
rebecca.repository provides directive for pyramid registry.:
config.include('rebecca.repository') config.add_repository(person_repository, 'person')
or using repository_config decorator:
@repository_config(name="person", args=(DBSession,)) class PersonRepository(SQLARepository): def __init__(self, dbsession): super(PersonRepository, self).__init__(Person, Person.id, dbsession)
To get registered repositories, use get_repository:
get_repository(request, 'person')
Contributors
Atsushi Odagiri, Original Author
Changelog
0.4 (2013-09-22)
file repository(yet)
0.3 (2013-08-29)
added repository factory API
added get_many method
0.2 (2013-08-25)
added pyramid config directive and venusian decorator
0.1.1 (2013-08-24)
fix packaging bug
0.1 (2013-08-24)
first release
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file rebecca.repository-0.4.zip
.
File metadata
- Download URL: rebecca.repository-0.4.zip
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b50a1e1f08c6220f78fd3dd00024a6ed802993c23e141fc4859d0aed2d23b48b |
|
MD5 | c265ee4ae82b85b177bee560aba738e4 |
|
BLAKE2b-256 | 111b13e4b2bb993f5c4ebc2e054b0c799433238dcb1a1aedeacfa4e43b640427 |
File details
Details for the file rebecca.repository-0.4-py2.py3-none-any.whl
.
File metadata
- Download URL: rebecca.repository-0.4-py2.py3-none-any.whl
- Upload date:
- Size: 9.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f17f9d561dbfd674a1bad72e367de5ae1719061bb4f8ab886d40f37a24e6488 |
|
MD5 | bbb57efc8fa3060d69f09dcd49341b38 |
|
BLAKE2b-256 | 482b83477fd74c641d8619038f3c168b63fa7025be9ef9ff43a30b2e2e29caea |