From a16f1725b1ea992c76fc52f6d09a5ad8d99d533d Mon Sep 17 00:00:00 2001 From: "angelinatingaeva@yandex.ru" Date: Tue, 26 Dec 2023 00:02:07 +0500 Subject: [PATCH] create(core): low-level test how it works --- README.md | 7 ++- alembic.ini | 116 ++++++++++++++++++++++++++++++++++++++ config.py | 11 ++++ main.py | 80 ++++++++++++++++++++++++++ migrations/README | 1 + migrations/env.py | 88 +++++++++++++++++++++++++++++ migrations/script.py.mako | 26 +++++++++ models/models.py | 24 ++++++++ 8 files changed, 351 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 config.py create mode 100644 main.py create mode 100644 migrations/README create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 models/models.py diff --git a/README.md b/README.md index aaf65eb..96d1711 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ -# Gate_B24YAT +# Обкатка FastAPI, Alembic, models для Gate_B24YAT + +# TEST SERVICE + +Integrational service for Yandex Tracker <--> Bitrix24 -Integrational service for Yandex Tracker <--> Bitrix24 \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..712dbdf --- /dev/null +++ b/alembic.ini @@ -0,0 +1,116 @@ +# 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>=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 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. + +# 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 = driver://user:pass@localhost/dbname +sqlalchemy.url = postgresql://%(DB_USER)s:%(DB_PASS)s@%(DB_HOST)s:%(DB_PORT)s/%(DB_NAME)s + +[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 = 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/config.py b/config.py new file mode 100644 index 0000000..b9a3161 --- /dev/null +++ b/config.py @@ -0,0 +1,11 @@ +from dotenv import load_dotenv +import os + +load_dotenv() + + +DB_HOST = os.environ.get("DB_HOST") +DB_PORT = os.environ.get("DB_PORT") +DB_NAME = os.environ.get("DB_NAME") +DB_USER = os.environ.get("DB_USER") +DB_PASS = os.environ.get("DB_PASS") \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..3ee97c4 --- /dev/null +++ b/main.py @@ -0,0 +1,80 @@ +from datetime import datetime +from enum import Enum +from fastapi import FastAPI +from pydantic import BaseModel, Field +from typing import List, Optional + +app = FastAPI( + title="Trading App" +) + + +fake_users = [ + {"id": 1, "role": "admin", "name": "Bob"}, + {"id": 2, "role": "investor", "name": "John"}, + {"id": 3, "role": "trader", "name": "Matt"}, + {"id": 4, "role": "investor", "name": "Hammer", "degree": [ + {"id": 1, "created_at": "2020-01-01T00:00:00", "type_degree": "expert"}, + ]}, +] + + +class DegreeType(Enum): + newbie = "newbie" + expert = "expert" + + + +class Degree(BaseModel): + id: int + created_at: datetime + type_degree: DegreeType + + +class User(BaseModel): + id: int + role: str + name: str + degree: Optional[List[Degree]] = 0 + + +@app.get("/users/{user_id}", response_model=List[User]) +def get_user(user_id: int): + return [user for user in fake_users if user.get("id") == user_id] + +fake_trades = [ + {"id": 1, "user_id": 1, "currency": "BTC", "side": "buy", "price": 123}, + {"id": 2, "user_id": 1, "currency": "BTC", "side": "sell", "price": 125}, +] + +@app.get("/trades") +def get_trades(limit: int = 2, offset: int = 1): + return fake_trades[offset:][:limit] + +fake_users2 = [ + {"id": 1, "role": "admin", "name": "Bob"}, + {"id": 2, "role": "investor", "name": "John"}, + {"id": 3, "role": "trader", "name": "Matt"}, +] + + +@app.post("/users/{users_id}") +def change_user_name(user_id: int, new_name: str): + current_user = list(filter(lambda user: user.get("id") == user_id, fake_users2))[0] + current_user["name"] = new_name + return {"status": 200, "data": current_user} + + +class Trade(BaseModel): + id: int + user_id: int + currency: str + side: str + price: float = Field(ge=0) + amount: float + + +@app.post("/trades") +def add_trades(trades: List[Trade]): + fake_trades.extend(trades) + return {"status": 200, "data": fake_trades} \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 0000000..98e4f9c --- /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 0000000..b440292 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,88 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from config import DB_HOST, DB_PORT, DB_USER, DB_NAME, DB_PASS +from models.models import metadata + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +section = config.config_ini_section +config.set_section_option(section, "DB_HOST", DB_HOST) +config.set_section_option(section, "DB_PORT", DB_PORT) +config.set_section_option(section, "DB_USER", DB_USER) +config.set_section_option(section, "DB_NAME", DB_NAME) +config.set_section_option(section, "DB_PASS", DB_PASS) + +# 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 = 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 0000000..fbc4b07 --- /dev/null +++ b/migrations/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/models/models.py b/models/models.py new file mode 100644 index 0000000..efee856 --- /dev/null +++ b/models/models.py @@ -0,0 +1,24 @@ +from datetime import datetime + +from sqlalchemy import MetaData, Table, Column, Integer, String, TIMESTAMP, ForeignKey, JSON + +metadata = MetaData() + +roles = Table( + "roles", + metadata, + Column("id", Integer, primary_key=True), + Column("name", String, nullable=False), + Column("permissions", JSON), +) + +users = Table( + "users", + metadata, + Column("id", Integer, primary_key=True), + Column("email", String, nullable=False), + Column("username", String, nullable=False), + Column("password", String, nullable=False), + Column("registered_at", TIMESTAMP, default=datetime.utcnow), + Column("role_id", Integer, ForeignKey("roles.id")), +) \ No newline at end of file