SQLAlchemy suport for Flask-Philo-Core.
Flask-Philo-Core implements simple funcionality for building flask based applications. This project provides SqlAlchemy support for Flask-Philo.
-
Support for mulitple database connections.
-
Basic Object Relational Mapper ORM.
-
Webhooks for Flask-Philo-Core views.
Flask-Philo-Core supports python3.6 or higher. There are no plans to support older Python versions.
pip3 install Flask-Philo-SQLAlchemy
Define one more connection strings to the configuration file:
'FLASK_PHILO_SQLALCHEMY': {
'DEFAULT': 'postgresql://ds:dsps@pgdb:5432/ds_test',
}
The following example shows a basic model that extends from
flask_philo_sqlalchemy.orm.BaseModel:
from flask_philo_sqlalchemy.orm import BaseModel
from flask_philo_sqlalchemy.types import Password
from sqlalchemy import Column, ForeignKey, Integer, String, Numeric, Boolean
class User(BaseModel):
__tablename__ = 'users'
username = Column(String(64))
password = Column(Password)
email = Column(String(64))
is_active = Column(Boolean(), nullable=False, default=False)
credit_score = Column(Numeric(), nullable=True)
def get_id(self):
return self.id
@classmethod
def authenticate(cls, username=None, email=None, password=None):
user = User.objects.get(username=username, email=email)
assert user.password == password
return user
Extend flask_philo_sqlalchemy.http.SQLAlchemyView to create a class based
view that instanciate a flask_philo_sqlalchemy.connection.ConnectionPool
object with a connection to each one of the databases defined in configuration:
from flask_philo_sqlalchemy.http import SQLAlchemyView
class UserResourceView(SQLAlchemyView):
def get(self, id=None):
try:
if id is not None:
user = User.objects.get(id=id)
data = {'id': user.id, 'username': user.username}
else:
data = [
{'id': user.id, 'username': user.username}
for user in User.objects.filter_by()
]
return self.json_response(status=200, data=data)
except NotFoundError:
return self.json_response(status=404)
def post(self):
obj = User(**request.json)
obj.add()
self.sqlalchemy_pool.commit()
data = {'id': obj.id}
return self.json_response(status=201, data=data)
def put(self, id=None):
obj = User.objects.get_for_update(id=id)
obj.username = request.json['username']
obj.update()
self.sqlalchemy_pool.commit()
obj = User.objects.get(id=id)
data = {'id': obj.id, 'username': obj.username}
return self.json_response(status=200, data=data)
def delete(self, id=None):
obj = User.objects.get(id=id)
obj.delete()
self.sqlalchemy_pool.commit()
return self.json_response(status=200)
Extend flask_philo_sqlalchemy.test.SQLAlchemyTestCase to create testcases
that with active connections to the databases:
class TestCaseModel(SQLAlchemyTestCase):
config = {
'FLASK_PHILO_EXTENSIONS': ('Flask-Philo-SQLAlchemy', ),
'Flask-Philo-SQLAlchemy': {
'DEFAULT': 'postgresql://ds:dsps@pgdb:5432/ds_test',
}
}
urls = (
('/users', UserResourceView, 'users'),
('/users/<int:id>', UserResourceView, 'user'),
)
def test_get(self):
with self.app.app_context():
assert 0 == User.objects.count()
user1 = ModelFactory.create_user()
user2 = ModelFactory.create_user()
assert 2 == User.objects.count()
client = self.app.test_client()
result = client.get('/users/{}'.format(user1.id))
assert 200 == result.status_code
j_content = json.loads(result.get_data().decode('utf-8'))
assert j_content['id'] == user1.id
client = self.app.test_client()
result2 = client.get('/users/{}'.format(user2.id))
assert 200 == result2.status_code
j_content2 = json.loads(result2.get_data().decode('utf-8'))
assert j_content2['id'] == user2.id
client = self.app.test_client()
result3 = client.get('/users')
assert 200 == result3.status_code
j_content3 = json.loads(result3.get_data().decode('utf-8'))
assert 2 == len(j_content3)
def test_post(self):
with self.app.app_context():
assert 0 == User.objects.count()
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = json.dumps({'username': 'username'})
client = self.app.test_client()
result = client.post('/users', data=data, headers=headers)
assert 201 == result.status_code
assert 1 == User.objects.count()
def test_put(self):
with self.app.app_context():
user = ModelFactory.create_user()
assert 1 == User.objects.count()
old_username = user.username
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = json.dumps({'username': 'newusername', 'id': user.id})
url = 'users/{}'.format(user.id)
client = self.app.test_client()
result = client.put(url, data=data, headers=headers)
assert 200 == result.status_code
assert 1 == User.objects.count()
j_content = json.loads(result.get_data().decode('utf-8'))
assert j_content['id'] == user.id
assert j_content['username'] != old_username
assert j_content['username'] == 'newusername'
def test_delete(self):
with self.app.app_context():
user1 = ModelFactory.create_user()
assert 1 == User.objects.count()
client = self.app.test_client()
result = client.delete('/users/{}'.format(user1.id))
assert 200 == result.status_code
assert 0 == User.objects.count()