Burathar
/
The-Hunt
1
0
Fork 0
Code Issues 24 Pull Requests Releases Wiki Activity
Browse Source

implement models.py up to documentation v1.2

feature_tests
Burathar 4 years ago
parent
a019578082
commit
c5e4c17d6d
7 changed files with 399 additions and 11 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 102
      app/models.py
  2. 1
      migrations/README
  3. 45
      migrations/alembic.ini
  4. 96
      migrations/env.py
  5. 24
      migrations/script.py.mako
  6. 86
      migrations/versions/08f2f998a4f6_update_models_to_database_documentation_.py
  7. 56
      migrations/versions/db3681fb9273_add_game_and_player_model.py

102
app/models.py
Unescape View File

@ -2,23 +2,53 @@ from app import app, db @@ -2,23 +2,53 @@ from app import app, db
from sqlalchemy.sql import func
game_player = db.Table('game_player',
db.Column('game_id', db.Integer, db.ForeignKey('game.id')),
db.Column('player_id', db.Integer, db.ForeignKey('player.id')),
db.Column('game_id', db.Integer, db.ForeignKey('game.id'), nullable=False),
db.Column('player_id', db.Integer, db.ForeignKey('player.id'), nullable=False),
db.PrimaryKeyConstraint('game_id', 'player_id'),
db.Column('role', db.String(16))
)
player_found_objective = db.Table('player_found_objective',
db.Column('game_id', db.Integer, db.ForeignKey('game.id'), nullable=False),
db.Column('player_id', db.Integer, db.ForeignKey('player.id'), nullable=False),
db.PrimaryKeyConstraint('game_id', 'player_id'),
db.Column('timestamp', db.DateTime, server_default=func.now(), nullable=False)
)
player_caught_player = db.Table('player_caught_player',
db.Column('catching_player_id', db.Integer, db.ForeignKey('player.id')),
db.Column('caught_player_id', db.Integer, db.ForeignKey('player.id')),
db.Column('photo_reference', db.String(128), unique=True, nullable=False),
db.Column('timestamp', db.DateTime, server_default=func.now(), nullable=False)
)
notification_player = db.Table('notification_player',
db.Column('notification_id', db.Integer, db.ForeignKey('notification.id')),
db.Column('player_id', db.Integer, db.ForeignKey('player.id')),
db.PrimaryKeyConstraint('notification_id', 'player_id'),
db.Column('been_shown', db.Boolean, server_default='True', nullable=False)
)
class Game(db.Model):
__tablename__ = 'game'
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(64), index=True, unique=True, nullable=False)
password_hash = db.Column(db.String(128), nullable=False)
state = db.Column(db.Integer, default='1')
state = db.Column(db.Integer, server_default='1')
start_time = db.Column(db.DateTime)
end_time = db.Column(db.DateTime)
players = relationship(
'player',
secondary=game_player,
back_populates='games')
players = db.relationship(
'Player',
secondary=game_player,
back_populates='games')
objectives = db.relationship(
'Objective',
lazy='select',
backref=db.backref('game', lazy='joined'))
notifications = db.relationship(
'Notification',
lazy='select',
backref=db.backref('game', lazy='joined'))
class Player(db.Model):
__tablename = 'player'
@ -26,10 +56,60 @@ class Player(db.Model): @@ -26,10 +56,60 @@ class Player(db.Model):
name = db.Column(db.String(64), unique=True, nullable=False)
auth_hash = db.Column(db.String(128), unique=True, nullable=False)
password_hash = db.Column(db.String(128))
games = relationship(
'game',
secondary=game_player,
back_populates='players')
games = db.relationship(
'Game',
secondary=game_player,
back_populates='players')
objectives_found = db.relationship(
'Objective',
secondary=player_found_objective,
back_populates='players')
caught_players = db.relationship(
'Player',
secondary=player_caught_player,
primaryjoin=(player_caught_player.c.catching_player_id == id),
secondaryjoin=(player_caught_player.c.caught_player_id == id),
backref=db.backref('caught_by', lazy='dynamic'), lazy='dynamic')
locations = db.relationship(
'Location',
lazy='select',
backref=db.backref('player', lazy='joined'))
notifications = db.relationship(
'Notification',
secondary=notification_player,
back_populates='recipients')
class Objective(db.Model):
__tablename = 'objective'
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(64), nullable=False)
game_id = db.Column(db.Integer, db.ForeignKey('game.id'), nullable=False)
hash = db.Column(db.String(128), unique=True, nullable=False)
longitude = db.Column(db.Numeric(precision=15, scale=10, asdecimal=False, decimal_return_scale=None)) # maybe check asdecimal and decimal_return_scale later?
latitude = db.Column(db.Numeric(precision=15, scale=10, asdecimal=False, decimal_return_scale=None))
players = db.relationship(
'Player',
secondary=player_found_objective,
back_populates='objectives_found')
class Location(db.Model):
__tablename = 'location'
id = db.Column(db.Integer, primary_key=True)
player_id = db.Column(db.Integer, db.ForeignKey('player.id'), nullable=False)
longitude = db.Column(db.Numeric(precision=15, scale=10, asdecimal=False, decimal_return_scale=None),nullable=False) # maybe check asdecimal and decimal_return_scale later?
latitude = db.Column(db.Numeric(precision=15, scale=10, asdecimal=False, decimal_return_scale=None),nullable=False)
timestamp = db.Column(db.DateTime, server_default=func.now(), nullable=False)
class Notification(db.Model):
__tablename = 'notification'
id = db.Column(db.Integer, primary_key=True)
game_id = db.Column(db.Integer, db.ForeignKey('game.id'), nullable=False)
message = db.Column(db.Text, nullable=False)
type = db.Column(db.String(64), nullable=False, default='General')
timestamp = db.Column(db.DateTime, server_default=func.now(), nullable=False)
recipients = db.relationship(
'Player',
secondary=notification_player,
back_populates='notifications')
#start_time = db.Column(db.DateTime, server_default=func.now())

1
migrations/README
Unescape View File

@ -0,0 +1 @@ @@ -0,0 +1 @@
Generic single-database configuration.

45
migrations/alembic.ini
Unescape View File

@ -0,0 +1,45 @@ @@ -0,0 +1,45 @@
# A generic, single database configuration.
[alembic]
# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
# set to 'true' to run the environment during
# the 'revision' command, regardless of autogenerate
# revision_environment = false
# Logging configuration
[loggers]
keys = root,sqlalchemy,alembic
[handlers]
keys = console
[formatters]
keys = generic
[logger_root]
level = WARN
handlers = console
qualname =
[logger_sqlalchemy]
level = WARN
handlers =
qualname = sqlalchemy.engine
[logger_alembic]
level = INFO
handlers =
qualname = alembic
[handler_console]
class = StreamHandler
args = (sys.stderr,)
level = NOTSET
formatter = generic
[formatter_generic]
format = %(levelname)-5.5s [%(name)s] %(message)s
datefmt = %H:%M:%S

96
migrations/env.py
Unescape View File

@ -0,0 +1,96 @@ @@ -0,0 +1,96 @@
from __future__ import with_statement
import logging
from logging.config import fileConfig
from sqlalchemy import engine_from_config
from sqlalchemy import pool
from alembic import context
# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config
# Interpret the config file for Python logging.
# This line sets up loggers basically.
fileConfig(config.config_file_name)
logger = logging.getLogger('alembic.env')
# add your model's MetaData object here
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
from flask import current_app
config.set_main_option(
'sqlalchemy.url',
str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%'))
target_metadata = current_app.extensions['migrate'].db.metadata
# other values from the config, defined by the needs of env.py,
# can be acquired:
# my_important_option = config.get_main_option("my_important_option")
# ... etc.
def run_migrations_offline():
"""Run migrations in 'offline' mode.
This configures the context with just a URL
and not an Engine, though an Engine is acceptable
here as well. By skipping the Engine creation
we don't even need a DBAPI to be available.
Calls to context.execute() here emit the given string to the
script output.
"""
url = config.get_main_option("sqlalchemy.url")
context.configure(
url=url, target_metadata=target_metadata, literal_binds=True
)
with context.begin_transaction():
context.run_migrations()
def run_migrations_online():
"""Run migrations in 'online' mode.
In this scenario we need to create an Engine
and associate a connection with the context.
"""
# this callback is used to prevent an auto-migration from being generated
# when there are no changes to the schema
# reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
def process_revision_directives(context, revision, directives):
if getattr(config.cmd_opts, 'autogenerate', False):
script = directives[0]
if script.upgrade_ops.is_empty():
directives[:] = []
logger.info('No changes in schema detected.')
connectable = engine_from_config(
config.get_section(config.config_ini_section),
prefix='sqlalchemy.',
poolclass=pool.NullPool,
)
with connectable.connect() as connection:
context.configure(
connection=connection,
target_metadata=target_metadata,
process_revision_directives=process_revision_directives,
**current_app.extensions['migrate'].configure_args
)
with context.begin_transaction():
context.run_migrations()
if context.is_offline_mode():
run_migrations_offline()
else:
run_migrations_online()

24
migrations/script.py.mako
Unescape View File

@ -0,0 +1,24 @@ @@ -0,0 +1,24 @@
"""${message}
Revision ID: ${up_revision}
Revises: ${down_revision | comma,n}
Create Date: ${create_date}
"""
from alembic import op
import sqlalchemy as sa
${imports if imports else ""}
# revision identifiers, used by Alembic.
revision = ${repr(up_revision)}
down_revision = ${repr(down_revision)}
branch_labels = ${repr(branch_labels)}
depends_on = ${repr(depends_on)}
def upgrade():
${upgrades if upgrades else "pass"}
def downgrade():
${downgrades if downgrades else "pass"}

86
migrations/versions/08f2f998a4f6_update_models_to_database_documentation_.py
Unescape View File

@ -0,0 +1,86 @@ @@ -0,0 +1,86 @@
"""update models to database documentation 1.2
Revision ID: 08f2f998a4f6
Revises: db3681fb9273
Create Date: 2020-07-02 18:45:23.912159
"""
from alembic import op
import sqlalchemy as sa
# revision identifiers, used by Alembic.
revision = '08f2f998a4f6'
down_revision = 'db3681fb9273'
branch_labels = None
depends_on = None
def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('location',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('player_id', sa.Integer(), nullable=False),
sa.Column('longitude', sa.Numeric(precision=15, scale=10, asdecimal=False), nullable=False),
sa.Column('latitude', sa.Numeric(precision=15, scale=10, asdecimal=False), nullable=False),
sa.Column('timestamp', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=False),
sa.ForeignKeyConstraint(['player_id'], ['player.id'], ),
sa.PrimaryKeyConstraint('id')
)
op.create_table('notification',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('game_id', sa.Integer(), nullable=False),
sa.Column('message', sa.Text(), nullable=False),
sa.Column('type', sa.String(length=64), nullable=False),
sa.Column('timestamp', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=False),
sa.ForeignKeyConstraint(['game_id'], ['game.id'], ),
sa.PrimaryKeyConstraint('id')
)
op.create_table('objective',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('name', sa.String(length=64), nullable=False),
sa.Column('game_id', sa.Integer(), nullable=False),
sa.Column('hash', sa.String(length=128), nullable=False),
sa.Column('longitude', sa.Numeric(precision=15, scale=10, asdecimal=False), nullable=True),
sa.Column('latitude', sa.Numeric(precision=15, scale=10, asdecimal=False), nullable=True),
sa.ForeignKeyConstraint(['game_id'], ['game.id'], ),
sa.PrimaryKeyConstraint('id'),
sa.UniqueConstraint('hash')
)
op.create_table('player_caught_player',
sa.Column('catching_player_id', sa.Integer(), nullable=True),
sa.Column('caught_player_id', sa.Integer(), nullable=True),
sa.Column('photo_reference', sa.String(length=128), nullable=False),
sa.Column('timestamp', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=False),
sa.ForeignKeyConstraint(['catching_player_id'], ['player.id'], ),
sa.ForeignKeyConstraint(['caught_player_id'], ['player.id'], ),
sa.UniqueConstraint('photo_reference')
)
op.create_table('player_found_objective',
sa.Column('game_id', sa.Integer(), nullable=False),
sa.Column('player_id', sa.Integer(), nullable=False),
sa.Column('timestamp', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=False),
sa.ForeignKeyConstraint(['game_id'], ['game.id'], ),
sa.ForeignKeyConstraint(['player_id'], ['player.id'], ),
sa.PrimaryKeyConstraint('game_id', 'player_id')
)
op.create_table('notification_player',
sa.Column('notification_id', sa.Integer(), nullable=False),
sa.Column('player_id', sa.Integer(), nullable=False),
sa.Column('been_shown', sa.Boolean(), server_default='True', nullable=False),
sa.ForeignKeyConstraint(['notification_id'], ['notification.id'], ),
sa.ForeignKeyConstraint(['player_id'], ['player.id'], ),
sa.PrimaryKeyConstraint('notification_id', 'player_id')
)
# ### end Alembic commands ###
def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('notification_player')
op.drop_table('player_found_objective')
op.drop_table('player_caught_player')
op.drop_table('objective')
op.drop_table('notification')
op.drop_table('location')
# ### end Alembic commands ###

56
migrations/versions/db3681fb9273_add_game_and_player_model.py
Unescape View File

@ -0,0 +1,56 @@ @@ -0,0 +1,56 @@
"""add game and player model
Revision ID: db3681fb9273
Revises:
Create Date: 2020-07-02 13:26:00.493728
"""
from alembic import op
import sqlalchemy as sa
# revision identifiers, used by Alembic.
revision = 'db3681fb9273'
down_revision = None
branch_labels = None
depends_on = None
def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('game',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('name', sa.String(length=64), nullable=False),
sa.Column('password_hash', sa.String(length=128), nullable=False),
sa.Column('state', sa.Integer(), nullable=True),
sa.Column('start_time', sa.DateTime(), nullable=True),
sa.Column('end_time', sa.DateTime(), nullable=True),
sa.PrimaryKeyConstraint('id')
)
op.create_index(op.f('ix_game_name'), 'game', ['name'], unique=True)
op.create_table('player',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('name', sa.String(length=64), nullable=False),
sa.Column('auth_hash', sa.String(length=128), nullable=False),
sa.Column('password_hash', sa.String(length=128), nullable=True),
sa.PrimaryKeyConstraint('id'),
sa.UniqueConstraint('auth_hash'),
sa.UniqueConstraint('name')
)
op.create_table('game_player',
sa.Column('game_id', sa.Integer(), nullable=True),
sa.Column('player_id', sa.Integer(), nullable=True),
sa.Column('role', sa.String(length=16), nullable=True),
sa.ForeignKeyConstraint(['game_id'], ['game.id'], ),
sa.ForeignKeyConstraint(['player_id'], ['player.id'], )
)
# ### end Alembic commands ###
def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('game_player')
op.drop_table('player')
op.drop_index(op.f('ix_game_name'), table_name='game')
op.drop_table('game')
# ### end Alembic commands ###
Write Preview
Loading…
Cancel
Save