diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 000000000..da95dbfdd --- /dev/null +++ b/alembic.ini @@ -0,0 +1,104 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# 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 migrations/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:migrations/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:///freebies.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/freebies.db b/freebies.db new file mode 100644 index 000000000..114384761 Binary files /dev/null and b/freebies.db differ diff --git a/lib/debug.py b/lib/debug.py index 4f922eb69..cacb0e2ea 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,9 +1,15 @@ #!/usr/bin/env python3 from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker -from models import Company, Dev +from models import Company, Dev, Freebie if __name__ == '__main__': engine = create_engine('sqlite:///freebies.db') + + Session = sessionmaker(bind=engine) + session = Session() + + import ipdb; ipdb.set_trace() diff --git a/lib/models.py b/lib/models.py index 2681bee5a..7c78208ca 100644 --- a/lib/models.py +++ b/lib/models.py @@ -12,18 +12,61 @@ 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", overlaps="devs,companies") + devs = relationship("Dev", secondary="freebies", back_populates="companies", overlaps="freebies,company") + + def give_freebie(self, dev, item_name, value): + new_freebie = Freebie(item_name=item_name, value=value, dev=dev, company=self) + return new_freebie + + @classmethod + def oldest_company(cls, session): + return session.query(cls).order_by(cls.founding_year).first() def __repr__(self): - return f'' + return f'' + 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", overlaps="companies,devs") + companies = relationship("Company", secondary="freebies", back_populates="devs", overlaps="freebies,dev") + + def received_one(self, item_name): + return any(freebie.item_name == item_name for freebie in self.freebies) + + def give_away(self, dev, freebie): + if freebie in self.freebies: + freebie.dev = dev def __repr__(self): return f'' + + +class Freebie(Base): + __tablename__ = 'freebies' + + + id = Column(Integer, primary_key=True) + item_name = Column(String, nullable=False) + value = Column(Integer) + dev_id = Column(Integer, ForeignKey('devs.id')) + company_id = Column(Integer, ForeignKey('companies.id')) + + dev = relationship("Dev", back_populates="freebies", overlaps="companies,devs") + company = relationship("Company", back_populates="freebies", overlaps="companies,devs") + + def print_details(self): + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" + + + def __repr__(self): + return f'' diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..5eb6b753f --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,81 @@ +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. +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 lib.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. + + """ + 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() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + 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() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..55df2863d --- /dev/null +++ b/migrations/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/migrations/versions/10665e093ff8_added_freebie_table.py b/migrations/versions/10665e093ff8_added_freebie_table.py new file mode 100644 index 000000000..f7c3f48c9 --- /dev/null +++ b/migrations/versions/10665e093ff8_added_freebie_table.py @@ -0,0 +1,50 @@ +"""Added Freebie table + +Revision ID: 10665e093ff8 +Revises: +Create Date: 2025-03-05 15:50:32.757111 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '10665e093ff8' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('companies', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('founding_year', sa.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('devs', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + 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('dev_id', sa.Integer(), nullable=True), + sa.Column('company_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') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('freebies') + op.drop_table('devs') + op.drop_table('companies') + # ### end Alembic commands ### diff --git a/migrations/versions/774f4e06401e_added_relationships_and_methods.py b/migrations/versions/774f4e06401e_added_relationships_and_methods.py new file mode 100644 index 000000000..9c01892b0 --- /dev/null +++ b/migrations/versions/774f4e06401e_added_relationships_and_methods.py @@ -0,0 +1,83 @@ +"""Added relationships and methods + +Revision ID: 774f4e06401e +Revises: 10665e093ff8 +Create Date: 2025-03-05 18:16:09.379213 + +""" +from alembic import op +import sqlalchemy as sa + +# Revision identifiers, used by Alembic. +revision = '774f4e06401e' +down_revision = '10665e093ff8' +branch_labels = None +depends_on = None + +def upgrade() -> None: + # Create new companies table with NOT NULL constraints + op.create_table( + 'new_companies', + sa.Column('id', sa.Integer, primary_key=True), + sa.Column('name', sa.String, nullable=False), # NOT NULL added + sa.Column('founding_year', sa.Integer, nullable=False), # NOT NULL added + ) + + # Copy data from old table to new table + op.execute("INSERT INTO new_companies (id, name, founding_year) SELECT id, name, founding_year FROM companies") + + # Drop old table + op.drop_table('companies') + + # Rename new table to original name + op.rename_table('new_companies', 'companies') + + # Create new devs table with NOT NULL constraints + op.create_table( + 'new_devs', + sa.Column('id', sa.Integer, primary_key=True), + sa.Column('name', sa.String, nullable=False), # NOT NULL added + ) + + # Copy data from old table to new table + op.execute("INSERT INTO new_devs (id, name) SELECT id, name FROM devs") + + # Drop old table + op.drop_table('devs') + + # Rename new table to original name + op.rename_table('new_devs', 'devs') + +def downgrade() -> None: + # Recreate companies table without NOT NULL constraints + op.create_table( + 'old_companies', + sa.Column('id', sa.Integer, primary_key=True), + sa.Column('name', sa.String, nullable=True), # Allow NULL + sa.Column('founding_year', sa.Integer, nullable=True), # Allow NULL + ) + + # Copy data back to original structure + op.execute("INSERT INTO old_companies (id, name, founding_year) SELECT id, name, founding_year FROM companies") + + # Drop modified table + op.drop_table('companies') + + # Rename back to original + op.rename_table('old_companies', 'companies') + + # Recreate devs table without NOT NULL constraints + op.create_table( + 'old_devs', + sa.Column('id', sa.Integer, primary_key=True), + sa.Column('name', sa.String, nullable=True), # Allow NULL + ) + + # Copy data back to original structure + op.execute("INSERT INTO old_devs (id, name) SELECT id, name FROM devs") + + # Drop modified table + op.drop_table('devs') + + # Rename back to original + op.rename_table('old_devs', 'devs')