Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor/scoped session fix #151

Closed
wants to merge 45 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
1b671e2
refactor, fix scoped session
Apr 9, 2021
d23ed8a
remove unused import
Apr 9, 2021
b5f0300
fix logger
Apr 9, 2021
022a3da
remove test_database, rename param
Apr 10, 2021
a3b32c4
fix exception formatting
Apr 10, 2021
663e6bd
simplify _session, execute
Apr 10, 2021
f8afbcc
fix is_postgres
Apr 10, 2021
62b9982
abstract away engine creation
Apr 10, 2021
da613be
fix pylint errors
Apr 10, 2021
4a593dd
rename _parse_command
Apr 12, 2021
6fcf7ed
rename _bind_params
Apr 12, 2021
a4989eb
wrap flask wrapper
Apr 12, 2021
e8827bf
factor out sanitizer
Apr 13, 2021
bd330a7
promote paramstyle and placeholders to instance variables
Apr 13, 2021
db4cce1
pass token type/value around
Apr 13, 2021
88adfb9
rename methods
Apr 13, 2021
a4a8810
move escape_verbatim_colons to constructor
Apr 13, 2021
f618840
reorder methods
Apr 13, 2021
9a153fe
use else
Apr 13, 2021
456cea5
escape args and kwargs in constructor
Apr 13, 2021
713368f
reorder methods
Apr 13, 2021
2187d95
refactor logger
Apr 13, 2021
758910e
fix style
Apr 13, 2021
32db777
factor out utility functions
Apr 13, 2021
1f62283
factor out session utility functions
Apr 13, 2021
c0534e2
factor out sql utility functions
Apr 13, 2021
37fba4f
remove underscore from util functions
Apr 13, 2021
e06131c
fix style
Apr 13, 2021
86f981f
reorder imports
Apr 13, 2021
67a7f0c
remove manual tests
Apr 13, 2021
839b1f1
add statement tests, rollback on error in autocommit
Apr 13, 2021
9302a1e
move operation check to Statement
Apr 14, 2021
f6912d2
use statement factory
Apr 14, 2021
08a6636
use remove instead of rollback
Apr 14, 2021
7f9b77c
rename _sanitized_statement
Apr 14, 2021
944934f
abstract away catch_warnings
Apr 14, 2021
006657e
remove BEGIN and COMMIT
Apr 14, 2021
36fb280
Revert "remove BEGIN and COMMIT"
Apr 14, 2021
a6668c0
rename methods
Apr 14, 2021
1440ae5
add docstrings
Apr 14, 2021
9e9cb0b
update cs50 docstrings
Apr 15, 2021
789bb40
use assertAlmostEqual
Apr 16, 2021
05a4d9d
enable autocommit by default
Apr 16, 2021
7bf7e16
avoid using sessions
Apr 16, 2021
0674b7c
delete transaction connection on failure
Apr 16, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
factor out session utility functions
Kareem Zidane committed Apr 13, 2021
commit 1f622834ddecd571a0c49190a190035f4bbb95e3
67 changes: 6 additions & 61 deletions src/cs50/_session.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
"""Wraps a SQLAlchemy scoped session"""

import os
import sqlite3

import sqlalchemy
import sqlalchemy.orm

from ._session_util import (
_is_sqlite_url,
_assert_sqlite_file_exists,
_create_session,
)


class Session:
"""Wraps a SQLAlchemy scoped session"""
@@ -23,61 +26,3 @@ def execute(self, statement):

def __getattr__(self, attr):
return getattr(self._session, attr)


def _is_sqlite_url(url):
return url.startswith("sqlite:///")


def _assert_sqlite_file_exists(url):
path = url[len("sqlite:///"):]
if not os.path.exists(path):
raise RuntimeError(f"does not exist: {path}")
if not os.path.isfile(path):
raise RuntimeError(f"not a file: {path}")


def _create_session(url, **engine_kwargs):
engine = _create_engine(url, **engine_kwargs)
_setup_on_connect(engine)
return _create_scoped_session(engine)


def _create_engine(url, **kwargs):
try:
engine = sqlalchemy.create_engine(url, **kwargs)
except sqlalchemy.exc.ArgumentError:
raise RuntimeError(f"invalid URL: {url}") from None

engine.execution_options(autocommit=False)
return engine


def _setup_on_connect(engine):
def connect(dbapi_connection, _):
_disable_auto_begin_commit(dbapi_connection)
if _is_sqlite_connection(dbapi_connection):
_enable_sqlite_foreign_key_constraints(dbapi_connection)

sqlalchemy.event.listen(engine, "connect", connect)


def _create_scoped_session(engine):
session_factory = sqlalchemy.orm.sessionmaker(bind=engine)
return sqlalchemy.orm.scoping.scoped_session(session_factory)


def _disable_auto_begin_commit(dbapi_connection):
# Disable underlying API's own emitting of BEGIN and COMMIT so we can ourselves
# https://docs.sqlalchemy.org/en/13/dialects/sqlite.html#serializable-isolation-savepoints-transactional-ddl
dbapi_connection.isolation_level = None


def _is_sqlite_connection(dbapi_connection):
return isinstance(dbapi_connection, sqlite3.Connection)


def _enable_sqlite_foreign_key_constraints(dbapi_connection):
cursor = dbapi_connection.cursor()
cursor.execute("PRAGMA foreign_keys=ON")
cursor.close()
63 changes: 63 additions & 0 deletions src/cs50/_session_util.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
"""Utility functions used by _session.py"""

import os
import sqlite3

import sqlalchemy

def _is_sqlite_url(url):
return url.startswith("sqlite:///")


def _assert_sqlite_file_exists(url):
path = url[len("sqlite:///"):]
if not os.path.exists(path):
raise RuntimeError(f"does not exist: {path}")
if not os.path.isfile(path):
raise RuntimeError(f"not a file: {path}")


def _create_session(url, **engine_kwargs):
engine = _create_engine(url, **engine_kwargs)
_setup_on_connect(engine)
return _create_scoped_session(engine)


def _create_engine(url, **kwargs):
try:
engine = sqlalchemy.create_engine(url, **kwargs)
except sqlalchemy.exc.ArgumentError:
raise RuntimeError(f"invalid URL: {url}") from None

engine.execution_options(autocommit=False)
return engine


def _setup_on_connect(engine):
def connect(dbapi_connection, _):
_disable_auto_begin_commit(dbapi_connection)
if _is_sqlite_connection(dbapi_connection):
_enable_sqlite_foreign_key_constraints(dbapi_connection)

sqlalchemy.event.listen(engine, "connect", connect)


def _create_scoped_session(engine):
session_factory = sqlalchemy.orm.sessionmaker(bind=engine)
return sqlalchemy.orm.scoping.scoped_session(session_factory)


def _disable_auto_begin_commit(dbapi_connection):
# Disable underlying API's own emitting of BEGIN and COMMIT so we can ourselves
# https://docs.sqlalchemy.org/en/13/dialects/sqlite.html#serializable-isolation-savepoints-transactional-ddl
dbapi_connection.isolation_level = None


def _is_sqlite_connection(dbapi_connection):
return isinstance(dbapi_connection, sqlite3.Connection)


def _enable_sqlite_foreign_key_constraints(dbapi_connection):
cursor = dbapi_connection.cursor()
cursor.execute("PRAGMA foreign_keys=ON")
cursor.close()