diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 000000000..cd10212e7 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,102 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration files +# file_template = %%(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 + +# Database URL - update this to point to your SQLite database +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/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-310.pyc b/alembic/__pycache__/env.cpython-310.pyc new file mode 100644 index 000000000..0b745e14c Binary files /dev/null and b/alembic/__pycache__/env.cpython-310.pyc differ diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 000000000..bb736e550 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,73 @@ +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) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +from models import Base # Adjust the import based on your project structure +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(): + """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. + + """ + 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/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /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(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/lib/debug.py b/lib/debug.py index 4f922eb69..fc9272e57 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,9 +1,23 @@ -#!/usr/bin/env python3 +# debug.py -from sqlalchemy import create_engine +from models import session, Company, Dev, Freebie -from models import Company, Dev +# Create sample data +google = session.query(Company).filter_by(name="Google").first() +alice = session.query(Dev).filter_by(name="Alice").first() +bob = session.query(Dev).filter_by(name="Bob").first() -if __name__ == '__main__': - engine = create_engine('sqlite:///freebies.db') - import ipdb; ipdb.set_trace() +# Test relationships +print(google.freebies) # Should return a list of freebies from Google +print(alice.companies) # Should return a list of companies Alice received freebies from + +# Test methods +google.give_freebie(alice, "Hat", 15) +print(google.freebies) # Should include the new freebie "Hat" +print(alice.received_one("Hat")) # Should return True + +freebie = session.query(Freebie).filter_by(item_name="Hat").first() +print(freebie.print_details()) # Should print "Alice owns a Hat from Google" + +alice.give_away(bob, freebie) +print(freebie.print_details()) # Should print "Bob owns a Hat from Google" diff --git a/lib/models.py b/lib/models.py index 2681bee5a..6be6cab50 100644 --- a/lib/models.py +++ b/lib/models.py @@ -1,29 +1,65 @@ -from sqlalchemy import ForeignKey, Column, Integer, String, MetaData -from sqlalchemy.orm import relationship, backref -from sqlalchemy.ext.declarative import declarative_base +# models.py -convention = { - "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", -} -metadata = MetaData(naming_convention=convention) +from sqlalchemy import create_engine, Column, Integer, String, ForeignKey +from sqlalchemy.orm import sessionmaker, relationship, backref, declarative_base -Base = declarative_base(metadata=metadata) +Base = declarative_base() +engine = create_engine('postgresql://user:password@localhost/freebie_db') +Session = sessionmaker(bind=engine) +session = Session() 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, nullable=False) - def __repr__(self): - return f'' + freebies = relationship('Freebie', backref='company', lazy=True) + + @property + def devs(self): + return list(set([freebie.dev for freebie in self.freebies])) + + def give_freebie(self, dev, item_name, value): + new_freebie = Freebie(item_name=item_name, value=value, dev=dev, company=self) + session.add(new_freebie) + session.commit() + + @classmethod + def oldest_company(cls): + return 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', backref='dev', lazy=True) + + @property + def companies(self): + return list(set([freebie.company for freebie in self.freebies])) + + 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 + session.commit() + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer, primary_key=True) + item_name = Column(String, nullable=False) + value = Column(Integer, nullable=False) + dev_id = Column(Integer, ForeignKey('devs.id'), nullable=False) + company_id = Column(Integer, ForeignKey('companies.id'), nullable=False) + + def print_details(self): + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" - def __repr__(self): - return f'' +Base.metadata.create_all(engine) diff --git a/lib/seed.py b/lib/seed.py index b16becbbb..1c4a67e1f 100644 --- a/lib/seed.py +++ b/lib/seed.py @@ -1,3 +1,27 @@ -#!/usr/bin/env python3 +# seed.py -# Script goes here! +from models import session, Company, Dev, Freebie + +def seed_data(): + session.query(Freebie).delete() + session.query(Company).delete() + session.query(Dev).delete() + session.commit() + + google = Company(name="Google", founding_year=1998) + amazon = Company(name="Amazon", founding_year=1994) + facebook = Company(name="Facebook", founding_year=2004) + + dev1 = Dev(name="Alice") + dev2 = Dev(name="Bob") + dev3 = Dev(name="Charlie") + + session.add_all([google, amazon, facebook, dev1, dev2, dev3]) + session.commit() + + freebie1 = Freebie(item_name="T-shirt", value=10, dev=dev1, company=google) + freebie2 = Freebie(item_name="Mug", value=5, dev=dev2, company=amazon) + freebie3 = Freebie(item_name="Sticker", value=1, dev=dev3, company=facebook) + + session.add_all([freebie1, freebie2, freebie3]) + session