Initial sqlalchemy example

jkimbo · jkimbo · commit ed13972a920a · 2021-09-09T17:28:34.000+01:00
diff --git a/fastapi-sqlalchemy/.flake8 b/fastapi-sqlalchemy/.flake8
@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 89
+exclude=.venv,.git
+ignore = W503
+extend-ignore =
+    # See https://github.com/PyCQA/pycodestyle/issues/373
+    E203,
diff --git a/fastapi-sqlalchemy/.projectroot b/fastapi-sqlalchemy/.projectroot
diff --git a/fastapi-sqlalchemy/alembic.ini b/fastapi-sqlalchemy/alembic.ini
@@ -0,0 +1,74 @@
+# 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"
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# 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/fastapi-sqlalchemy/alembic/README b/fastapi-sqlalchemy/alembic/README
@@ -0,0 +1 @@
+Generic single-database configuration.
diff --git a/fastapi-sqlalchemy/alembic/env.py b/fastapi-sqlalchemy/alembic/env.py
@@ -0,0 +1,85 @@
+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  # type: ignore
+
+# 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
+# target_metadata = None
+
+from main.database import Base  # noqa
+
+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 get_url():
+    return "sqlite:///./db.sqlite3"
+
+
+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 = get_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():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    configuration = config.get_section(config.config_ini_section)
+    configuration["sqlalchemy.url"] = get_url()
+    connectable = engine_from_config(
+        configuration,
+        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/fastapi-sqlalchemy/alembic/script.py.mako b/fastapi-sqlalchemy/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/fastapi-sqlalchemy/alembic/versions/e690282050a1_add_initial_models.py b/fastapi-sqlalchemy/alembic/versions/e690282050a1_add_initial_models.py
@@ -0,0 +1,53 @@
+"""Add initial models
+
+Revision ID: e690282050a1
+Revises:
+Create Date: 2021-09-09 17:27:04.631432
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "e690282050a1"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "directors",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("name", sa.String(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_index(op.f("ix_directors_id"), "directors", ["id"], unique=False)
+    op.create_index(op.f("ix_directors_name"), "directors", ["name"], unique=True)
+    op.create_table(
+        "movies",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("title", sa.String(), nullable=True),
+        sa.Column("imdb_id", sa.String(), nullable=True),
+        sa.Column("year", sa.Integer(), nullable=True),
+        sa.Column("image_url", sa.String(), nullable=True),
+        sa.Column("imdb_rating", sa.Float(), nullable=True),
+        sa.Column("imdb_rating_count", sa.String(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_index(op.f("ix_movies_id"), "movies", ["id"], unique=False)
+    op.create_index(op.f("ix_movies_imdb_id"), "movies", ["imdb_id"], unique=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f("ix_movies_imdb_id"), table_name="movies")
+    op.drop_index(op.f("ix_movies_id"), table_name="movies")
+    op.drop_table("movies")
+    op.drop_index(op.f("ix_directors_name"), table_name="directors")
+    op.drop_index(op.f("ix_directors_id"), table_name="directors")
+    op.drop_table("directors")
+    # ### end Alembic commands ###
diff --git a/fastapi-sqlalchemy/api/__init__.py b/fastapi-sqlalchemy/api/__init__.py
diff --git a/fastapi-sqlalchemy/api/definitions/__init__.py b/fastapi-sqlalchemy/api/definitions/__init__.py
diff --git a/fastapi-sqlalchemy/api/definitions/director.py b/fastapi-sqlalchemy/api/definitions/director.py
@@ -0,0 +1,16 @@
+import strawberry
+
+from main.models import Director as DirectorModel
+
+
+@strawberry.type
+class Director:
+    id: int
+    name: str
+
+    @classmethod
+    def from_instance(cls, instance: DirectorModel):
+        return cls(
+            id=instance.id,
+            name=instance.name,
+        )
diff --git a/fastapi-sqlalchemy/api/definitions/movie.py b/fastapi-sqlalchemy/api/definitions/movie.py
@@ -0,0 +1,35 @@
+import strawberry
+
+from main.models import Movie as MovieModel
+
+from .director import Director
+
+
+@strawberry.type
+class Movie:
+    id: int
+    imdb_id: str
+    title: str
+    year: int
+    image_url: str
+    imdb_rating: float
+    imdb_rating_count: str
+
+    instance: strawberry.Private[MovieModel]
+
+    @strawberry.field
+    def director(self) -> Director:
+        return Director.from_instance(self.instance.director)
+
+    @classmethod
+    def from_instance(cls, instance: MovieModel):
+        return cls(
+            instance=instance,
+            id=instance.id,
+            imdb_id=instance.imdb_id,
+            title=instance.title,
+            year=instance.year,
+            image_url=instance.image_url,
+            imdb_rating=instance.imdb_rating,
+            imdb_rating_count=instance.imdb_rating_count,
+        )
diff --git a/fastapi-sqlalchemy/api/schema.py b/fastapi-sqlalchemy/api/schema.py
@@ -0,0 +1,33 @@
+from typing import List
+
+import strawberry
+from strawberry.extensions import Extension
+
+from main.models import get_all_movies
+from main.database import SessionLocal
+
+from .definitions.movie import Movie
+
+
+class SQLAlchemySession(Extension):
+    def on_request_start(self):
+        self.execution_context.context["db"] = SessionLocal()
+
+    def on_request_end(self):
+        self.execution_context.context["db"].close()
+
+
+@strawberry.type
+class Query:
+    @strawberry.field
+    def ping(self) -> str:
+        return "pong"
+
+    @strawberry.field
+    def top_250(self, info) -> List[Movie]:
+        db = info.context["db"]
+        movies = get_all_movies(db)
+        return [Movie.from_instance(movie) for movie in movies]
+
+
+schema = strawberry.Schema(Query)
diff --git a/fastapi-sqlalchemy/main/__init__.py b/fastapi-sqlalchemy/main/__init__.py
@@ -0,0 +1,9 @@
+from fastapi import FastAPI
+from strawberry.asgi import GraphQL
+
+from api.schema import schema
+
+graphql_app = GraphQL(schema)
+
+app = FastAPI()
+app.add_route("/graphql", graphql_app)
diff --git a/fastapi-sqlalchemy/main/database.py b/fastapi-sqlalchemy/main/database.py
@@ -0,0 +1,13 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+
+
+SQLALCHEMY_DATABASE_URL = "sqlite:///./db.sqlite3"
+
+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/fastapi-sqlalchemy/main/models.py b/fastapi-sqlalchemy/main/models.py
@@ -0,0 +1,30 @@
+from sqlalchemy import Column, Integer, String, Float
+from sqlalchemy.orm import relationship, joinedload
+from sqlalchemy.orm import Session
+
+from .database import Base
+
+
+class Director(Base):
+    __tablename__ = "directors"
+
+    id: int = Column(Integer, primary_key=True, index=True)
+    name: str = Column(String, unique=True, index=True)
+
+
+class Movie(Base):
+    __tablename__ = "movies"
+
+    id: int = Column(Integer, primary_key=True, index=True)
+    title: str = Column(String)
+    imdb_id: str = Column(String, index=True)
+    year: int = Column(Integer)
+    image_url: str = Column(String)
+    imdb_rating: float = Column(Float)
+    imdb_rating_count: str = Column(String)
+
+    director: Director = relationship("Director")
+
+
+def get_all_movies(db: Session):
+    return db.query(Movie).options(joinedload(Movie.director)).all()
diff --git a/fastapi-sqlalchemy/poetry.lock b/fastapi-sqlalchemy/poetry.lock
diff --git a/fastapi-sqlalchemy/pyproject.toml b/fastapi-sqlalchemy/pyproject.toml
diff --git a/fastapi-sqlalchemy/setup.cfg b/fastapi-sqlalchemy/setup.cfg
