From d382d6ad3f4768ec02ac5f6ecaf3964d448963e9 Mon Sep 17 00:00:00 2001 From: Arduinum Date: Thu, 25 Dec 2025 17:08:17 +0300 Subject: [PATCH] feat: added models, migrations, alembic, additional_dependencies; fix: fixed parametr for SettingsDB --- .gitignore | 1 + .pre-commit-config.yaml | 4 + alembic.ini | 147 ++++++++++++++++++ src/kawai_focus_v2/core/__init__.py | 0 src/kawai_focus_v2/core/settings.py | 34 ++++ src/kawai_focus_v2/database/__init__.py | 0 src/kawai_focus_v2/database/alembic/README | 1 + src/kawai_focus_v2/database/alembic/env.py | 82 ++++++++++ .../database/alembic/script.py.mako | 28 ++++ ...25_12_25_1504-503b50886979_create_timer.py | 42 +++++ src/kawai_focus_v2/database/mixins.py | 13 ++ src/kawai_focus_v2/database/models.py | 46 ++++++ 12 files changed, 398 insertions(+) create mode 100644 alembic.ini create mode 100644 src/kawai_focus_v2/core/__init__.py create mode 100644 src/kawai_focus_v2/core/settings.py create mode 100644 src/kawai_focus_v2/database/__init__.py create mode 100644 src/kawai_focus_v2/database/alembic/README create mode 100644 src/kawai_focus_v2/database/alembic/env.py create mode 100644 src/kawai_focus_v2/database/alembic/script.py.mako create mode 100644 src/kawai_focus_v2/database/alembic/versions/2025_12_25_1504-503b50886979_create_timer.py create mode 100644 src/kawai_focus_v2/database/mixins.py create mode 100644 src/kawai_focus_v2/database/models.py diff --git a/.gitignore b/.gitignore index d6d15a0..5164f54 100644 --- a/.gitignore +++ b/.gitignore @@ -60,6 +60,7 @@ cover/ local_settings.py db.sqlite3 db.sqlite3-journal +*.sqlite3 # Flask stuff: instance/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7f6e651..b8babd2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -24,3 +24,7 @@ repos: rev: 0.0.3 hooks: - id: ty-check + additional_dependencies: + - sqlalchemy + - alembic + - pydantic-settings diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..0010f4a --- /dev/null +++ b/alembic.ini @@ -0,0 +1,147 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/src/kawai_focus_v2/database/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. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the tzdata library which can be 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 /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 "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + +# 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 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +#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 + +# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module +# hooks = ruff +# ruff.type = module +# ruff.module = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Alternatively, use the exec runner to execute a binary found on your PATH +hooks = ruff +ruff.type = exec +ruff.executable = uv +ruff.options = run ruff format REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[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/src/kawai_focus_v2/core/__init__.py b/src/kawai_focus_v2/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/kawai_focus_v2/core/settings.py b/src/kawai_focus_v2/core/settings.py new file mode 100644 index 0000000..79a7b24 --- /dev/null +++ b/src/kawai_focus_v2/core/settings.py @@ -0,0 +1,34 @@ +from pydantic_settings import BaseSettings, SettingsConfigDict +from pydantic import Field + + +class ModelConfig(BaseSettings): + """Модель конфигурации""" + + model_config = SettingsConfigDict( + env_file='.env', + env_file_encoding='utf-8', + extra='ignore' + ) + + +class SettingsDB(ModelConfig): + """Класс для данных БД""" + + name_db: str + echo_db: bool + + @property + def get_url_db(self) -> str: + """Метод вернёт URL для подключения к БД""" + + return f'sqlite:///{self.name_db}' + + +class Settings(ModelConfig): + """Класс для данных конфига""" + + db_settings: SettingsDB = Field(default_factory=SettingsDB) + + +settings = Settings() diff --git a/src/kawai_focus_v2/database/__init__.py b/src/kawai_focus_v2/database/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/kawai_focus_v2/database/alembic/README b/src/kawai_focus_v2/database/alembic/README new file mode 100644 index 0000000..2500aa1 --- /dev/null +++ b/src/kawai_focus_v2/database/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. diff --git a/src/kawai_focus_v2/database/alembic/env.py b/src/kawai_focus_v2/database/alembic/env.py new file mode 100644 index 0000000..3b3493e --- /dev/null +++ b/src/kawai_focus_v2/database/alembic/env.py @@ -0,0 +1,82 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from kawai_focus_v2.core.settings import settings +from kawai_focus_v2.database.models import Base + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config +config.set_main_option("sqlalchemy.url", settings.db_settings.get_url_db) + +# 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/src/kawai_focus_v2/database/alembic/script.py.mako b/src/kawai_focus_v2/database/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/src/kawai_focus_v2/database/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${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, Sequence[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: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/src/kawai_focus_v2/database/alembic/versions/2025_12_25_1504-503b50886979_create_timer.py b/src/kawai_focus_v2/database/alembic/versions/2025_12_25_1504-503b50886979_create_timer.py new file mode 100644 index 0000000..901f1fd --- /dev/null +++ b/src/kawai_focus_v2/database/alembic/versions/2025_12_25_1504-503b50886979_create_timer.py @@ -0,0 +1,42 @@ +"""Create Timer + +Revision ID: 503b50886979 +Revises: +Create Date: 2025-12-25 15:04:03.485293 + +""" + +from collections.abc import Sequence + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = "503b50886979" +down_revision: str | Sequence[str] | None = None +branch_labels: str | Sequence[str] | None = None +depends_on: str | Sequence[str] | None = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.create_table( + "timer", + sa.Column("название", sa.String(length=200), nullable=False), + sa.Column("время помидора", sa.Integer(), nullable=False), + sa.Column("время перерыва", sa.Integer(), nullable=False), + sa.Column("время долгого перерыва", sa.Integer(), nullable=False), + sa.Column("количество помидоров", sa.Integer(), nullable=False), + sa.Column("id", sa.Integer(), autoincrement=True, nullable=False), + sa.PrimaryKeyConstraint("id"), + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table("timer") + # ### end Alembic commands ### diff --git a/src/kawai_focus_v2/database/mixins.py b/src/kawai_focus_v2/database/mixins.py new file mode 100644 index 0000000..73c1149 --- /dev/null +++ b/src/kawai_focus_v2/database/mixins.py @@ -0,0 +1,13 @@ +from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy import Integer + + +class IDMixin: + """Базовый класс для моделей с id""" + + id: Mapped[int] = mapped_column( + Integer, + name='id', + primary_key=True, + autoincrement=True + ) diff --git a/src/kawai_focus_v2/database/models.py b/src/kawai_focus_v2/database/models.py new file mode 100644 index 0000000..11bd4ee --- /dev/null +++ b/src/kawai_focus_v2/database/models.py @@ -0,0 +1,46 @@ +from sqlalchemy.orm import DeclarativeBase, mapped_column, Mapped +from sqlalchemy import Integer, String + +from kawai_focus_v2.database.mixins import IDMixin + + +class Base(DeclarativeBase): + """Класс для корректной работы аннотаций""" + + pass + + +class Timer(IDMixin, Base): + """Модель таймера""" + + __tablename__ = 'timer' + + title: Mapped[str] = mapped_column( + String(length=200), + name='название', + nullable=False + ) + + pomodoro_time: Mapped[int] = mapped_column( + Integer, + name='время помидора', + nullable=False + ) + + break_time: Mapped[int] = mapped_column( + Integer, + name='время перерыва', + nullable=False + ) + + break_long_time: Mapped[int] = mapped_column( + Integer, + name='время долгого перерыва', + nullable=False + ) + + count_pomodoro: Mapped[int] = mapped_column( + Integer, + name='количество помидоров', + nullable=False + )