From a12e243e628ab5957d1e16fb8df117f1685f02ad Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:14:59 +0300 Subject: [PATCH 1/9] Configure Alembic to use Base metadata from models.py for migration autogeneration --- lib/migrations/env.py | 56 ++++++++++--------------------------------- 1 file changed, 12 insertions(+), 44 deletions(-) diff --git a/lib/migrations/env.py b/lib/migrations/env.py index c7aab9656..80af34849 100644 --- a/lib/migrations/env.py +++ b/lib/migrations/env.py @@ -1,44 +1,19 @@ 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 +from models import Base # Import Base from models.py -# this is the Alembic Config object, which provides -# access to the values within the .ini file in use. +# this is the Alembic Config object 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) +# Interpret the config file for Python logging +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 +# Add your model's MetaData object here 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.""" url = config.get_main_option("sqlalchemy.url") context.configure( url=url, @@ -50,14 +25,8 @@ def run_migrations_offline() -> None: 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.""" connectable = engine_from_config( config.get_section(config.config_ini_section), prefix="sqlalchemy.", @@ -66,14 +35,13 @@ 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 ) with context.begin_transaction(): context.run_migrations() - if context.is_offline_mode(): run_migrations_offline() else: - run_migrations_online() + run_migrations_online() \ No newline at end of file From c91c76e952c248fb0640cd535e5d52ea39360093 Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:15:35 +0300 Subject: [PATCH 2/9] Add Alembic migration template for tracking schema changes --- lib/migrations/script.py.mako | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/migrations/script.py.mako b/lib/migrations/script.py.mako index 55df2863d..22704f4cc 100644 --- a/lib/migrations/script.py.mako +++ b/lib/migrations/script.py.mako @@ -5,20 +5,24 @@ Revises: ${down_revision | comma,n} Create Date: ${create_date} """ +from typing import Sequence, Union + 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)} +revision: str = ${repr(up_revision)} +down_revision: Union[str, None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} def upgrade() -> None: + """Upgrade schema.""" ${upgrades if upgrades else "pass"} def downgrade() -> None: - ${downgrades if downgrades else "pass"} + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} \ No newline at end of file From ea14ad1b00aca6a34976407a5defa249da87b38a Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:16:15 +0300 Subject: [PATCH 3/9] Configure alembic.ini for SQLite and migration script settings --- lib/alembic.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/alembic.ini b/lib/alembic.ini index 953863ddd..d175406bd 100644 --- a/lib/alembic.ini +++ b/lib/alembic.ini @@ -55,7 +55,7 @@ version_path_separator = os # Use os.pathsep. Default configuration used for ne # are written from script.py.mako # output_encoding = utf-8 -sqlalchemy.url = sqlite:///freebies.db +sqlalchemy.url = sqlite:///instance/freebies.db [post_write_hooks] From 77ef31b31b810f5dda6ff0173bca6f9fa3454d65 Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:17:06 +0300 Subject: [PATCH 4/9] Add SQLAlchemy models for Company, Dev, and Freebie with relationships and methods --- lib/models.py | 65 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 50 insertions(+), 15 deletions(-) diff --git a/lib/models.py b/lib/models.py index 2681bee5a..4f0556dc8 100644 --- a/lib/models.py +++ b/lib/models.py @@ -1,29 +1,64 @@ -from sqlalchemy import ForeignKey, Column, Integer, String, MetaData -from sqlalchemy.orm import relationship, backref +from sqlalchemy import create_engine, Column, Integer, String, ForeignKey from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import relationship, sessionmaker -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) + founding_year = Column(Integer) + + freebies = relationship("Freebie", backref="company") + devs = relationship("Dev", secondary="freebies", backref="companies") + + def give_freebie(self, dev, item_name, value): + """Creates a new Freebie associated with this company and the given dev.""" + freebie = Freebie(item_name=item_name, value=value, dev=dev, company=self) + return freebie + + @classmethod + def oldest_company(cls, session): + """Returns the Company instance with the earliest founding year.""" + 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) + + freebies = relationship("Freebie", backref="dev") + + def received_one(self, item_name): + """Returns True if the dev has a freebie with the given item_name, else False.""" + return any(freebie.item_name == item_name for freebie in self.freebies) + + def give_away(self, new_dev, freebie): + """Transfers the freebie to new_dev if it belongs to this dev.""" + if freebie.dev == self: + freebie.dev = new_dev + + def __repr__(self): + return f"" + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer, primary_key=True) + item_name = Column(String) + value = Column(Integer) + dev_id = Column(Integer, ForeignKey('devs.id')) + company_id = Column(Integer, ForeignKey('companies.id')) + + def print_details(self): + """Returns a formatted string with dev name, item name, and company name.""" + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" def __repr__(self): - return f'' + return f"" \ No newline at end of file From 7ff60ffc92020741727468cf8cdf421112525dee Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:18:11 +0300 Subject: [PATCH 5/9] Add database seeding script with sample companies, devs, and freebies --- lib/seed.py | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/lib/seed.py b/lib/seed.py index b16becbbb..53016895e 100644 --- a/lib/seed.py +++ b/lib/seed.py @@ -1,3 +1,41 @@ #!/usr/bin/env python3 # Script goes here! +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from models import Base, Company, Dev, Freebie + +engine = create_engine('sqlite:///freebies.db') +Base.metadata.create_all(engine) + +Session = sessionmaker(bind=engine) +session = Session() + +# Clear existing data +session.query(Freebie).delete() +session.query(Dev).delete() +session.query(Company).delete() + +# Create sample companies +company1 = Company(name="TechCorp", founding_year=2000) +company2 = Company(name="InnovateInc", founding_year=2010) +session.add_all([company1, company2]) + +# Create sample devs +dev1 = Dev(name="Alice") +dev2 = Dev(name="Bob") +session.add_all([dev1, dev2]) + +# Commit companies and devs +session.commit() + +# Create sample freebies +freebie1 = Freebie(item_name="T-shirt", value=20, dev=dev1, company=company1) +freebie2 = Freebie(item_name="Mug", value=10, dev=dev1, company=company2) +freebie3 = Freebie(item_name="Sticker", value=5, dev=dev2, company=company1) +session.add_all([freebie1, freebie2, freebie3]) + +# Commit freebies +session.commit() + +print("Database seeded successfully!") \ No newline at end of file From de6a8c9c66da9b4465fdbbd820fe25ba24c1c6f7 Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:18:43 +0300 Subject: [PATCH 6/9] Add default Alembic env.py configuration for migration setup --- migrations/env.py | 78 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 migrations/env.py diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..6626bfd0c --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,78 @@ +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 +target_metadata = None + +# 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() From 8a17bbd5c05d4ff6573de683b5ef04ce026c8e3d Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:19:34 +0300 Subject: [PATCH 7/9] Add Alembic migration script template with upgrade and downgrade stubs --- migrations/script.py.mako | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 migrations/script.py.mako 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"} From 31481228c193dcb346047ba79c97892790177d3f Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:20:04 +0300 Subject: [PATCH 8/9] Add generic Alembic configuration file with logging and migration settings --- alembic.ini | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 alembic.ini diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 000000000..ebf940abd --- /dev/null +++ b/alembic.ini @@ -0,0 +1,105 @@ +# 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 = driver://user:pass@localhost/dbname + + +[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 From 121a5768ab497eb440e355e7abde8959f078cda1 Mon Sep 17 00:00:00 2001 From: Regina Wanjiru Kariuki Date: Tue, 27 May 2025 23:21:42 +0300 Subject: [PATCH 9/9] encrypted file --- migrations/__pycache__/env.cpython-38.pyc | Bin 0 -> 1622 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 migrations/__pycache__/env.cpython-38.pyc diff --git a/migrations/__pycache__/env.cpython-38.pyc b/migrations/__pycache__/env.cpython-38.pyc new file mode 100644 index 0000000000000000000000000000000000000000..fb8dad4852d537822cc70bc9f845612db8646c0a GIT binary patch literal 1622 zcmZvc&yO256vyrPnM|_T?m|m1NWLwRP>O`gsjAv8AQhoiSz3W|8F|M};?&~_wr787 z_taiEtojddNRIqVbLGUpfI#rz$Dy}Fu%mJ0?MTLDGEOk!$vhpWJe_w~{JN{Z;n>-4 z-0FDTWid;B!7OE+x6wFT_qr^DUXLfs{tD@Hp1naBsf733Ka0Od!`|;)V%;v#hbm85H*F1s7q9tZ{ zg)fl}=HUgh5erzzB7s?a1>3a2GG3u~18*fO5cdOmh`vLI=tsm7keSl2A?RVPNGYb8 zT2U!Ogd%&@WFkT69w{rvM_ESTc{vk?w4!Ux4Y4!sx=t}U5q3uAwXuYfSBKyF`BX8Y zD)1=smEZQKu%xP|vuh85h_op9!qOwj{i+$)oKQnfxRfJ8o}Cf%S}YbqO?|>P5-BwI zYWNS>P2xEVr5}Lkl;r8R%N&*F_#;?MV6+>0S8yW9NG00awSP#aVOj z_JVv(#K$n*xHYJs;Rpx*m;9Ne8P*?y_ZF}LIGi94>=+D-EM5i{&%+gfYomG0f~)Wn zU7#i4`R=nzY~k)*VB2NkRRGwg%WMsBy6oKs_y)=mpd6q7{C^y)|6u%FK^cKNQ*cGK zsDQMV8OMXe3V7KN`<`QJOjQU!=Acnf8#vV#`y2OQgF^2H3d5jD7Mf4QY14HVy^s(L zoY{38U$ui_Ux#o;dJCGS=L&7wG|g^X-&`oM@#)CT>KxQkzJQ?q+u>AsAoRA2<4#`R zam@}ikg>PU=x&1k$PKtcw#^4%HFy7AbANgdVaVKv2BiVcpy1J8N#cu-g1?gp3h$s8 zZjA@BngVyzQ7c!w@;BM_QMB9h!c)MzJQ77K*YEhwdXw&hnY-K4Zoon16ExexY$(j# pXX%D|zYo8K&LbGAC4cNbmR@x~=wo;zr!-5V&fxywUI%xAe*hZ$x+wqv literal 0 HcmV?d00001