From 1bb0cdab13fcdbe97fd04ef74fa0f55a47650e3d Mon Sep 17 00:00:00 2001 From: Maksym Nimych Date: Sun, 17 Nov 2024 22:27:10 +0200 Subject: [PATCH 1/2] Solution --- .gitignore | 1 + alembic.ini | 117 ++++++++++++++++++ alembic/README | 1 + alembic/env.py | 80 ++++++++++++ alembic/script.py.mako | 26 ++++ .../ca6b8fd2dcec_initial_migration.py | 50 ++++++++ crud.py | 56 +++++++++ database.py | 17 +++ main.py | 73 +++++++++++ models.py | 26 ++++ requirements.txt | 14 +++ schemas.py | 44 +++++++ 12 files changed, 505 insertions(+) create mode 100644 alembic.ini create mode 100644 alembic/README create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako create mode 100644 alembic/versions/ca6b8fd2dcec_initial_migration.py create mode 100644 crud.py create mode 100644 database.py create mode 100644 main.py create mode 100644 models.py create mode 100644 requirements.txt create mode 100644 schemas.py diff --git a/.gitignore b/.gitignore index 7ed07d08..e0e77352 100644 --- a/.gitignore +++ b/.gitignore @@ -60,6 +60,7 @@ coverage.xml local_settings.py db.sqlite3 db.sqlite3-journal +*.db # Flask stuff: instance/ diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 00000000..301c7c0f --- /dev/null +++ b/alembic.ini @@ -0,0 +1,117 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +# Use forward slashes (/) also on windows to provide an os agnostic path +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>=3.9 or backports.zoneinfo library. +# Any required deps can installed by adding `alembic[tz]` to the pip requirements +# string value is passed to ZoneInfo() +# 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 = newline +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = sqlite:///./library.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 + +# lint with attempts to fix using "ruff" - use the exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = --fix REVISION_SCRIPT_FILENAME + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +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 00000000..98e4f9c4 --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 00000000..55c0ce3d --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,80 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from models import Base + +# 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 = 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/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 00000000..fbc4b07d --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,26 @@ +"""${message} + +Revision ID: ${up_revision} +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: 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: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/ca6b8fd2dcec_initial_migration.py b/alembic/versions/ca6b8fd2dcec_initial_migration.py new file mode 100644 index 00000000..98e01069 --- /dev/null +++ b/alembic/versions/ca6b8fd2dcec_initial_migration.py @@ -0,0 +1,50 @@ +"""Initial migration + +Revision ID: ca6b8fd2dcec +Revises: +Create Date: 2024-11-17 14:28:16.861809 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = 'ca6b8fd2dcec' +down_revision: Union[str, None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('author', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=64), nullable=False), + sa.Column('bio', sa.String(length=255), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_index(op.f('ix_author_id'), 'author', ['id'], unique=False) + op.create_table('book', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(length=64), nullable=False), + sa.Column('summary', sa.String(length=255), nullable=False), + sa.Column('publication_date', sa.Date(), nullable=False), + sa.Column('author_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['author_id'], ['author.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_book_id'), 'book', ['id'], unique=False) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_book_id'), table_name='book') + op.drop_table('book') + op.drop_index(op.f('ix_author_id'), table_name='author') + op.drop_table('author') + # ### end Alembic commands ### diff --git a/crud.py b/crud.py new file mode 100644 index 00000000..4784ac86 --- /dev/null +++ b/crud.py @@ -0,0 +1,56 @@ +from sqlalchemy.orm import Session + +import models +import schemas + + +def get_books_list(db: Session, author_id: int | None = None): + queryset = db.query(models.DBBook) + + if author_id: + queryset = queryset.filter(models.DBBook.author_id == author_id) + + return queryset.all() + + +def create_book(db: Session, book: schemas.BookCreate): + db_book = models.DBBook( + title=book.title, + summary=book.summary, + publication_date=book.publication_date, + author_id=book.author_id, + ) + db.add(db_book) + db.commit() + db.refresh(db_book) + + return db_book + + +def get_author_list(db: Session, offset: int, limit: int): + authors = db.query(models.DBAuthor).offset(offset).limit(limit).all() + return authors + + +def get_author(db: Session, author_id: int): + return db.query(models.DBAuthor).filter( + models.DBAuthor.id == author_id + ).first() + + +def get_author_by_name(db: Session, author_name: str): + return db.query(models.DBAuthor).filter( + models.DBAuthor.name == author_name + ).first() + + +def create_author(db: Session, author: schemas.AuthorCreate): + db_author = models.DBAuthor( + name=author.name, + bio=author.bio, + ) + db.add(db_author) + db.commit() + db.refresh(db_author) + + return db_author diff --git a/database.py b/database.py new file mode 100644 index 00000000..24d125d9 --- /dev/null +++ b/database.py @@ -0,0 +1,17 @@ +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from sqlalchemy.ext.declarative import declarative_base + + +SQLALCHEMY_DATABASE_URL = "sqlite:///./library.db" + +engine = create_engine( + SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False} +) +SessionLocal = sessionmaker( + autocommit=False, + autoflush=False, + bind=engine +) + +Base = declarative_base() diff --git a/main.py b/main.py new file mode 100644 index 00000000..74a0ffe7 --- /dev/null +++ b/main.py @@ -0,0 +1,73 @@ +from fastapi import Depends, FastAPI, HTTPException +from sqlalchemy.orm import Session + +import crud +import schemas +from database import SessionLocal + + +app = FastAPI() + + +def get_db() -> Session: + db = SessionLocal() + + try: + yield db + finally: + db.close() + + +@app.get("/books/", response_model=list[schemas.Book]) +def read_books( + author_id: int | None = None, + db: Session = Depends(get_db), +): + return crud.get_books_list(db=db, author_id=author_id) + + +@app.post("/books/", response_model=schemas.BookCreate) +def create_book( + book: schemas.BookCreate, + db: Session = Depends(get_db), +): + return crud.create_book(db=db, book=book) + + +@app.get("/authors/", response_model=list[schemas.Author]) +def read_authors( + db: Session = Depends(get_db), + offset: int = 0, + limit: int = 100, +): + return crud.get_author_list(db=db, offset=offset, limit=limit) + + +@app.get("/authors/{author_id}/", response_model=schemas.Author) +def read_single_author(author_id: int, db: Session = Depends(get_db)): + db_author = crud.get_author(db=db, author_id=author_id) + + if db_author is None: + raise HTTPException( + status_code=404, + detail=f"Author with id {author_id} not found", + ) + + return db_author + + +@app.post("/authors/", response_model=schemas.AuthorCreate) +def create_author( + author: schemas.AuthorCreate, + db: Session = Depends(get_db), +): + + db_author = crud.get_author_by_name(db=db, author_name=author.name) + + if db_author: + raise HTTPException( + status_code=400, + detail=f"Author with name {author.name} already exists", + ) + + return crud.create_author(db=db, author=author) diff --git a/models.py b/models.py new file mode 100644 index 00000000..9955c38d --- /dev/null +++ b/models.py @@ -0,0 +1,26 @@ +from sqlalchemy import Column, Date, ForeignKey, Integer, String +from sqlalchemy.orm import relationship + +from database import Base + + +class DBBook(Base): + __tablename__ = "book" + + id = Column(Integer, primary_key=True, index=True) + title = Column(String(64), nullable=False) + summary = Column(String(255), nullable=False) + publication_date = Column(Date, nullable=False) + author_id = Column(Integer, ForeignKey("author.id")) + + authors = relationship("DBAuthor", back_populates="books") + + +class DBAuthor(Base): + __tablename__ = "author" + + id = Column(Integer, primary_key=True, index=True) + name = Column(String(64), nullable=False, unique=True) + bio = Column(String(255), nullable=False) + + books = relationship(DBBook, back_populates="authors") diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..5fc32f5a --- /dev/null +++ b/requirements.txt @@ -0,0 +1,14 @@ +alembic==1.14.0 +annotated-types==0.7.0 +anyio==4.6.2.post1 +fastapi==0.115.5 +greenlet==3.1.1 +idna==3.10 +Mako==1.3.6 +MarkupSafe==3.0.2 +pydantic==2.9.2 +pydantic_core==2.23.4 +sniffio==1.3.1 +SQLAlchemy==2.0.36 +starlette==0.41.2 +typing_extensions==4.12.2 diff --git a/schemas.py b/schemas.py new file mode 100644 index 00000000..4a91be6d --- /dev/null +++ b/schemas.py @@ -0,0 +1,44 @@ +from datetime import date +from pydantic import BaseModel + + +class BookBase(BaseModel): + title: str + summary: str + publication_date: date + author_id: int + + +class BookCreate(BookBase): + pass + + +class Book(BookBase): + id: int + + class Config: + from_attributes = True + + +class BookAuthor(BaseModel): + title: str + summary: str + publication_date: date + id: int + + +class AuthorBase(BaseModel): + name: str + bio: str + + +class AuthorCreate(AuthorBase): + pass + + +class Author(AuthorBase): + id: int + books: list[BookAuthor] + + class Config: + from_attributes = True From 817021cd0b40fae7f13aa5feafd3b9cf6a264984 Mon Sep 17 00:00:00 2001 From: Maksym Nimych Date: Sun, 17 Nov 2024 22:34:17 +0200 Subject: [PATCH 2/2] Fix response_model parameters for book and authorPOST methods --- main.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/main.py b/main.py index 74a0ffe7..9f1f7996 100644 --- a/main.py +++ b/main.py @@ -26,7 +26,7 @@ def read_books( return crud.get_books_list(db=db, author_id=author_id) -@app.post("/books/", response_model=schemas.BookCreate) +@app.post("/books/", response_model=schemas.Book) def create_book( book: schemas.BookCreate, db: Session = Depends(get_db), @@ -56,7 +56,7 @@ def read_single_author(author_id: int, db: Session = Depends(get_db)): return db_author -@app.post("/authors/", response_model=schemas.AuthorCreate) +@app.post("/authors/", response_model=schemas.Author) def create_author( author: schemas.AuthorCreate, db: Session = Depends(get_db),