diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 000000000..ac4af2719 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,105 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python-dateutil library that can be +# installed by adding `alembic[tz]` to the pip requirements +# string value is passed to dateutil.tz.gettz() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the +# "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to alembic/versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = sqlite:///instance/app.db + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# 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 diff --git a/alembic/README b/alembic/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/__pycache__/env.cpython-38.pyc b/alembic/__pycache__/env.cpython-38.pyc new file mode 100644 index 000000000..39760945e Binary files /dev/null and b/alembic/__pycache__/env.cpython-38.pyc differ diff --git a/alembic/config.py b/alembic/config.py new file mode 100644 index 000000000..1cba7ce35 --- /dev/null +++ b/alembic/config.py @@ -0,0 +1,18 @@ + +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker + +SQLALCHEMY_DATABASE_URI = "sqlite:///freebies.db" + +engine = create_engine(SQLALCHEMY_DATABASE_URI) +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + +Base = declarative_base() + +def get_db(): + db = SessionLocal() + try: + yield db + finally: + db.close() \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 000000000..339123eeb --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,44 @@ +from logging.config import fileConfig +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from alembic import context +import sys +import os + +sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) +from config import Base +from models import Company, Dev, Freebie + +config = context.config +fileConfig(config.config_file_name) +target_metadata = Base.metadata + +def run_migrations_offline(): + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + with context.begin_transaction(): + context.run_migrations() + +def run_migrations_online(): + 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 + ) + with context.begin_transaction(): + context.run_migrations() + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() \ No newline at end of file diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 000000000..55df2863d --- /dev/null +++ b/alembic/script.py.mako @@ -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() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/f4b9ba6d292a_create_freebies_table.py b/alembic/versions/f4b9ba6d292a_create_freebies_table.py new file mode 100644 index 000000000..7db156b02 --- /dev/null +++ b/alembic/versions/f4b9ba6d292a_create_freebies_table.py @@ -0,0 +1,35 @@ +"""create freebies table + +Revision ID: f4b9ba6d292a +Revises: +Create Date: 2025-05-28 06:45:20.608435 + +""" +from alembic import op +import sqlalchemy as sa + + +revision = 'f4b9ba6d292a' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.create_table('freebies', + sa.Column('id', sa.Integer(), nullable=False, primary_key=True), + sa.Column('item_name', sa.String(), nullable=False), + sa.Column('value', sa.Integer(), nullable=False), + sa.Column('company_id', sa.Integer(), sa.ForeignKey('companies.id'), nullable=False), + sa.Column('dev_id', sa.Integer(), sa.ForeignKey('devs.id'), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + + op.create_index(op.f('ix_freebies_company_id'), 'freebies', ['company_id']) + op.create_index(op.f('ix_freebies_dev_id'), 'freebies', ['dev_id']) + + +def downgrade() -> None: + op.drop_index(op.f('ix_freebies_dev_id'), table_name='freebies') + op.drop_index(op.f('ix_freebies_company_id'), table_name='freebies') + op.drop_table('freebies') diff --git a/lib/__pycache__/__init__.py b/lib/__pycache__/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/lib/__pycache__/models.cpython-38.pyc b/lib/__pycache__/models.cpython-38.pyc new file mode 100644 index 000000000..29afeee36 Binary files /dev/null and b/lib/__pycache__/models.cpython-38.pyc differ diff --git a/lib/debug.py b/lib/debug.py index 4f922eb69..d4cbcec48 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,9 +1,46 @@ #!/usr/bin/env python3 from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from models import Company, Dev, Freebie, Base -from models import Company, Dev - -if __name__ == '__main__': +def debug_session(): + engine = create_engine('sqlite:///freebies.db') + Base.metadata.create_all(engine) + + Session = sessionmaker(bind=engine) + session = Session() + + + company = Company(name="TestCorp", founding_year=2005) + dev = Dev(name="TestDev") + session.add_all([company, dev]) + session.commit() + + + freebie = Freebie( + item_name="TestItem", + value=50, + company=company, + dev=dev + ) + session.add(freebie) + session.commit() + + print("Test objects created:") + print(f"- company: {company}") + print(f"- dev: {dev}") + print(f"- freebie: {freebie}") + print("\nTry these commands:") + print("freebie.print_details()") + print("company.freebies") + print("dev.companies") + print("Company.oldest_company(session)") + print("dev.received_one('TestItem')") + print("dev.give_away(other_dev, freebie, session)") + import ipdb; ipdb.set_trace() + +if __name__ == '__main__': + debug_session() \ No newline at end of file diff --git a/lib/freebies.db b/lib/freebies.db index 12beb1c96..462d28ffd 100644 Binary files a/lib/freebies.db and b/lib/freebies.db differ diff --git a/lib/migrations/env.py b/lib/migrations/env.py index c7aab9656..0041b1012 100644 --- a/lib/migrations/env.py +++ b/lib/migrations/env.py @@ -1,63 +1,35 @@ from logging.config import fileConfig - -from sqlalchemy import engine_from_config -from sqlalchemy import pool - +from sqlalchemy import engine_from_config, pool from alembic import context +import os +import sys + +sys.path.insert(0, os.path.dirname(os.path.dirname(__file__))) -# 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. if config.config_file_name is not None: fileConfig(config.config_file_name) -# add your model's MetaData object here -# for 'autogenerate' support -# from myapp import mymodel -# target_metadata = mymodel.Base.metadata from models import Base target_metadata = Base.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() -> None: - """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. - - """ +def run_migrations_offline(): + """Run migrations in 'offline' mode (for generate/script output).""" url = config.get_main_option("sqlalchemy.url") context.configure( url=url, target_metadata=target_metadata, literal_binds=True, dialect_opts={"paramstyle": "named"}, + render_as_batch=True ) with context.begin_transaction(): context.run_migrations() - -def run_migrations_online() -> None: - """Run migrations in 'online' mode. - - In this scenario we need to create an Engine - and associate a connection with the context. - - """ +def run_migrations_online(): + """Run migrations in 'online' mode (connects to DB).""" connectable = engine_from_config( config.get_section(config.config_ini_section), prefix="sqlalchemy.", @@ -66,7 +38,10 @@ def run_migrations_online() -> None: with connectable.connect() as connection: context.configure( - connection=connection, target_metadata=target_metadata, render_as_batch=True, + connection=connection, + target_metadata=target_metadata, + render_as_batch=True, + compare_type=True, ) with context.begin_transaction(): @@ -76,4 +51,4 @@ def run_migrations_online() -> None: if context.is_offline_mode(): run_migrations_offline() else: - run_migrations_online() + run_migrations_online() \ No newline at end of file diff --git a/lib/migrations/versions/1b5e2cf295ac_initial_migration.py b/lib/migrations/versions/1b5e2cf295ac_initial_migration.py new file mode 100644 index 000000000..523720631 --- /dev/null +++ b/lib/migrations/versions/1b5e2cf295ac_initial_migration.py @@ -0,0 +1,57 @@ +"""Initial migration + +Revision ID: 1b5e2cf295ac +Revises: 5f72c58bf48c +Create Date: 2025-05-28 20:44:53.602088 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '1b5e2cf295ac' +down_revision = '5f72c58bf48c' +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('freebies', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('item_name', sa.String(), nullable=False), + sa.Column('value', sa.Integer(), nullable=False), + sa.Column('company_id', sa.Integer(), nullable=True), + sa.Column('dev_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['company_id'], ['companies.id'], name=op.f('fk_freebies_company_id_companies')), + sa.ForeignKeyConstraint(['dev_id'], ['devs.id'], name=op.f('fk_freebies_dev_id_devs')), + sa.PrimaryKeyConstraint('id') + ) + with op.batch_alter_table('companies', schema=None) as batch_op: + batch_op.alter_column('name', + existing_type=sa.VARCHAR(), + nullable=False) + + with op.batch_alter_table('devs', schema=None) as batch_op: + batch_op.alter_column('name', + existing_type=sa.VARCHAR(), + nullable=False) + + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('devs', schema=None) as batch_op: + batch_op.alter_column('name', + existing_type=sa.VARCHAR(), + nullable=True) + + with op.batch_alter_table('companies', schema=None) as batch_op: + batch_op.alter_column('name', + existing_type=sa.VARCHAR(), + nullable=True) + + op.drop_table('freebies') + # ### end Alembic commands ### diff --git a/lib/models.py b/lib/models.py index 2681bee5a..ec6fd8325 100644 --- a/lib/models.py +++ b/lib/models.py @@ -1,29 +1,76 @@ -from sqlalchemy import ForeignKey, Column, Integer, String, MetaData +from sqlalchemy import Column, Integer, String, ForeignKey from sqlalchemy.orm import relationship, backref -from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.ext.associationproxy import association_proxy +from sqlalchemy.orm import declarative_base -convention = { - "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", -} -metadata = MetaData(naming_convention=convention) - -Base = declarative_base(metadata=metadata) +Base = declarative_base() class Company(Base): __tablename__ = 'companies' - id = Column(Integer(), primary_key=True) - name = Column(String()) - founding_year = Column(Integer()) + id = Column(Integer, primary_key=True) + name = Column(String, nullable=False) + founding_year = Column(Integer) + + freebies = relationship("Freebie", back_populates="company") + devs = association_proxy('freebies', 'dev', + creator=lambda dev: Freebie(dev=dev)) def __repr__(self): return f'' + def give_freebie(self, dev, item_name, value, db_session): + freebie = Freebie( + item_name=item_name, + value=value, + company=self, + dev=dev + ) + db_session.add(freebie) + db_session.commit() + return freebie + + @classmethod + def oldest_company(cls, db_session): + return db_session.query(cls).order_by(cls.founding_year).first() + class Dev(Base): __tablename__ = 'devs' - id = Column(Integer(), primary_key=True) - name= Column(String()) + id = Column(Integer, primary_key=True) + name = Column(String, nullable=False) + + freebies = relationship("Freebie", back_populates="dev") + companies = association_proxy('freebies', 'company', + creator=lambda company: Freebie(company=company)) def __repr__(self): return f'' + + def received_one(self, item_name): + return any(f.item_name == item_name for f in self.freebies) + + def give_away(self, dev, freebie, db_session): + if freebie in self.freebies: + freebie.dev = dev + db_session.commit() + return True + return False + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer, primary_key=True) + item_name = Column(String, nullable=False) + value = Column(Integer, nullable=False) + company_id = Column(Integer, ForeignKey('companies.id')) + dev_id = Column(Integer, ForeignKey('devs.id')) + + company = relationship("Company", back_populates="freebies") + dev = relationship("Dev", back_populates="freebies") + + def __repr__(self): + return f'' + + def print_details(self): + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" \ No newline at end of file diff --git a/lib/seed.py b/lib/seed.py index b16becbbb..e9336293a 100644 --- a/lib/seed.py +++ b/lib/seed.py @@ -1,3 +1,42 @@ -#!/usr/bin/env python3 +from config import Base, engine, SessionLocal +from models import Company, Dev, Freebie -# Script goes here! +def seed_database(): + Base.metadata.create_all(bind=engine) + db = SessionLocal() + print(" Clearing old data...") + db.query(Freebie).delete() + db.query(Company).delete() + db.query(Dev).delete() + db.commit() + + print("Creating companies...") + companies = [ + Company(name="TechCorp", founding_year=2000), + Company(name="DevSoft", founding_year=1995), + Company(name="CodeMasters", founding_year=2010) + ] + db.add_all(companies) + + print("Creating devs...") + devs = [ + Dev(name="Alice"), + Dev(name="Bob"), + Dev(name="Charlie") + ] + db.add_all(devs) + db.commit() + + print("Creating freebies...") + freebies = [ + Freebie(item_name="T-shirt", value=15, dev=devs[0], company=companies[0]), + Freebie(item_name="Mug", value=10, dev=devs[0], company=companies[1]), + Freebie(item_name="Sticker", value=5, dev=devs[1], company=companies[0]), + Freebie(item_name="Laptop", value=1000, dev=devs[2], company=companies[2]) + ] + db.add_all(freebies) + db.commit() + print("Database seeded successfully!") + +if __name__ == '__main__': + seed_database() \ No newline at end of file