instant-python 0.20.0__py3-none-any.whl

instant_python/templates/boilerplate/persistence/async/alembic.ini

@@ -0,0 +1,124 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+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 and tzdata 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 = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+version_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
+
+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 exec runner, execute a binary
+hooks = ruff_lint, ruff_format
+ruff_lint.type = exec
+ruff_lint.executable = %(here)s/.venv/bin/ruff
+ruff_lint.options = check --fix REVISION_SCRIPT_FILENAME
+
+# format with attempts to fix using "ruff" - use the exec runner, execute a binary
+ruff_format.type = exec
+ruff_format.executable = %(here)s/.venv/bin/ruff
+ruff_format.options = format 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

instant_python/templates/boilerplate/persistence/async/async_engine_fixture.py

@@ -0,0 +1,20 @@
+from collections.abc import AsyncGenerator
+import pytest
+from sqlalchemy.ext.asyncio import AsyncEngine, create_async_engine
+
+from {{ general.source_name }}{{ "shared.infra.persistence.postgres_settings" | resolve_import_path(template.name) }} import PostgresSettings
+
+
+@pytest.fixture
+async def engine() -> AsyncGenerator[AsyncEngine]:
+	settings = PostgresSettings()  # type: ignore
+	engine = create_async_engine(settings.postgres_url)
+
+	async with engine.begin() as conn:
+		await conn.run_sync(EntityModel.metadata.create_all)
+
+	yield engine
+
+	async with engine.begin() as conn:
+		await conn.run_sync(EntityModel.metadata.drop_all)
+	await engine.dispose()

instant_python/templates/boilerplate/persistence/async/async_session.py

@@ -0,0 +1,20 @@
+from collections.abc import AsyncGenerator
+
+from sqlalchemy.ext.asyncio import create_async_engine
+from sqlalchemy.ext.asyncio.session import AsyncSession
+
+from {{ general.source_name }}{{ "shared.infra.persistence.postgres_settings" | resolve_import_path(template.name) }} import PostgresSettings
+
+
+settings = PostgresSettings()  # type: ignore
+engine = create_async_engine(str(settings.postgres_url))
+
+
+async def get_async_session() -> AsyncGenerator[AsyncSession]:
+    async with AsyncSession(engine) as session:
+        try:
+            yield session
+            await session.commit()
+        except Exception:
+            await session.rollback()
+            raise

instant_python/templates/boilerplate/persistence/async/env.py

@@ -0,0 +1,94 @@
+import asyncio
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import async_engine_from_config
+
+from migrations.models_metadata import base
+from {{ general.source_name }}{{ "shared.infra.persistence.postgres_settings" | resolve_import_path(template.name) }} import PostgresSettings
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+settings = PostgresSettings()  # type: ignore
+config.set_main_option("sqlalchemy.url", settings.postgres_url)
+
+# 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 do_run_migrations(connection: Connection) -> None:
+	context.configure(connection=connection, target_metadata=target_metadata)
+
+	with context.begin_transaction():
+		context.run_migrations()
+
+
+async def run_async_migrations() -> None:
+	"""In this scenario we need to create an Engine
+	and associate a connection with the context.
+
+	"""
+
+	connectable = async_engine_from_config(
+		config.get_section(config.config_ini_section, {}),
+		prefix="sqlalchemy.",
+		poolclass=pool.NullPool,
+	)
+
+	async with connectable.connect() as connection:
+		await connection.run_sync(do_run_migrations)
+
+	await connectable.dispose()
+
+
+def run_migrations_online() -> None:
+	"""Run migrations in 'online' mode."""
+
+	asyncio.run(run_async_migrations())
+
+
+if context.is_offline_mode():
+	run_migrations_offline()
+else:
+	run_migrations_online()

instant_python/templates/boilerplate/persistence/async/models_metadata.py

@@ -0,0 +1,10 @@
+"""
+This  module is needed for alembic to detect correctly all models of the project.
+
+When we import Base.metadata in the env.py file it will include all the models that inherit from it only if these models
+have already been imported. To keep the env.py file clean, we import the Base.metadata in this file and then import all the
+needed models.
+"""
+from {{ general.source_name }}{{ "shared.infra.persistence.sqlalchemy.base" | resolve_import_path(template.name) }} import Base
+
+base = Base

instant_python/templates/boilerplate/persistence/async/postgres_settings.py

@@ -0,0 +1,15 @@
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class PostgresSettings(BaseSettings):
+	model_config = SettingsConfigDict(env_file=(".env", ".env.prod"), extra="ignore")
+	postgres_user: str = Field(alias="POSTGRES_USER")
+	postgres_password: str = Field(alias="POSTGRES_PASSWORD")
+	postgres_db: str = Field(alias="POSTGRES_DB")
+	postgres_host: str = Field(alias="POSTGRES_HOST")
+	postgres_port: str = Field(alias="POSTGRES_PORT")
+
+	@property
+	def postgres_url(self) -> str:
+		return f"postgresql+asyncpg://{self.postgres_user}:{self.postgres_password}@{self.postgres_host}:{self.postgres_port}/{self.postgres_db}"

instant_python/templates/boilerplate/persistence/async/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"}

instant_python/templates/boilerplate/persistence/async/sqlalchemy_repository.py

@@ -0,0 +1,28 @@
+from typing import TypeVar
+
+from {{ general.source_name }}{{ "shared.domain.value_objects.uuid" | resolve_import_path(template.name) }} import Uuid
+from {{ general.source_name }}{{ "shared.infra.persistence.sqlalchemy.base" | resolve_import_path(template.name) }} import Base
+from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, async_sessionmaker
+
+
+Entity = TypeVar("Entity")
+
+
+class SqlalchemyRepository[Model: Base]:
+	_model_class: type[Model]
+	_session_maker: async_sessionmaker[AsyncSession]
+
+	def __init__(self, engine: AsyncEngine, model_class: type[Model]) -> None:
+		self._session_maker = async_sessionmaker(bind=engine)
+		self._model_class = model_class
+
+	async def persist(self, entity: Entity) -> None:
+		async with self._session_maker() as session:
+			entity_model = self._model_class(**entity.to_dict())
+			session.add(entity_model)
+			await session.commit()
+
+	async def find(self, entity_id: Uuid) -> Entity:
+		async with self._session_maker() as session:
+			entity_model = await session.get(self._model_class, entity_id.value)
+			return entity_model.to_aggregate() if entity_model else None

instant_python/templates/boilerplate/persistence/base.py

@@ -0,0 +1,4 @@
+from sqlalchemy.orm import DeclarativeBase
+
+
+class Base(DeclarativeBase): ...

instant_python/templates/boilerplate/persistence/synchronous/session_maker.py

@@ -0,0 +1,21 @@
+from sqlalchemy import create_engine, Engine
+from sqlalchemy.orm import sessionmaker, Session
+
+from {{ general.source_name }}{{ "shared.infra.persistence.sqlalchemy.base" | resolve_import_path(template.name) }} import (
+	Base,
+)
+
+
+class SessionMaker:
+	_session_maker: sessionmaker[Session]
+	_engine: Engine
+
+	def __init__(self, url: str) -> None:
+		self._engine = create_engine(url)
+		self._session_maker = sessionmaker(bind=self._engine)
+
+	def get_session(self) -> Session:
+		return self._session_maker()
+
+	def create_tables(self) -> None:
+		Base.metadata.create_all(self._engine)

instant_python/templates/boilerplate/persistence/synchronous/sqlalchemy_repository.py

@@ -0,0 +1,40 @@
+{% if general.python_version in ["3.13", "3.12", "3.11"] %}
+from typing import TypeVar
+{% else %}
+from typing import TypeVar, Generic
+{% endif %}
+
+from {{ general.source_name }}{{ "shared.domain.value_object.uuid" | resolve_import_path(template.name) }} import Uuid
+from {{ general.source_name }}{{ "shared.infra.persistence.sqlalchemy.base" | resolve_import_path(template.name) }} import Base
+from {{ general.source_name }}{{ "shared.infra.persistence.sqlalchemy.session_maker" | resolve_import_path(template.name) }} import (
+	SessionMaker,
+)
+
+Entity = TypeVar("Entity")
+{% if general.python_version in ["3.13", "3.12", "3.11"] %}
+class SqlAlchemyRepository[Model: Base]:	
+{% else %}
+Model = TypeVar("Model", bound=Base)
+class SqlAlchemyRepository(Generic[Model]):
+{% endif %}
+	_model_class: type[Model]
+	_session_maker: SessionMaker
+
+	def __init__(self, session_maker: SessionMaker, model_class: Type[Model]) -> None:
+		self._session_maker = session_maker
+		self._model_class = model_class
+
+	def persist(self, entity: Entity) -> None:
+		with self._session_maker.get_session() as session:
+			entity_model = self._model_class(**entity.to_dict())
+			session.add(entity_model)
+			session.commit()
+
+	def search_by_id(self, entity_id: Uuid) -> Entity | None:
+		with self._session_maker.get_session() as session:
+			entity_model = (
+				session.query(self._model_class)
+				.filter(self._model_class.id == entity_id.value)
+				.first()
+			)
+			return entity_model.to_aggregate() if entity_model else None

instant_python/templates/boilerplate/pyproject.toml

@@ -0,0 +1,134 @@
+{% set feature_to_main_dependencies = {
+    "async_sqlalchemy": ["sqlalchemy", "asyncpg", "psycopg2-binary", "pydantic", "pydantic-settings"],
+    "async_alembic": ["alembic", "pydantic", "pydantic-settings"],
+    "event_bus": ["pika", "sindripy"],
+    "fastapi_application": ["fastapi[standard]"],
+    "value_objects": ["sindripy"]
+} %}
+{% macro get_main_dependencies() -%}
+    {%- set deps = [] -%}
+    {%- for feature, dependencies in feature_to_main_dependencies.items() -%}
+        {%- if feature in template.built_in_features -%}
+            {%- set _ = deps.extend(dependencies) -%}
+        {%- endif -%}
+    {%- endfor -%}
+    {% for dep in deps %}
+    "{{ dep }}",
+    {% endfor -%}
+{%- endmacro %}
+{% set has_github_actions_or_makefile = ["github_actions", "makefile"] | is_in(template.built_in_features) %}
+{% set feature_to_dev_dependencies = {
+    "release": {
+    "python-semantic-release": ["github_actions"]
+    },
+    "lint": {
+    "mypy": ["github_actions", "makefile", "precommit_hook"],
+    "ruff": ["github_actions", "makefile", "precommit_hook"],
+    "pip-audit": ["github_actions"],
+    "pre-commit": ["precommit_hook"]
+    },
+    "test": {
+    "pytest": ["github_actions", "makefile", "precommit_hook"],
+    "pytest-asyncio": ["async_alembic", "async_sqlalchemy"]
+    }
+} %}
+{% macro get_dev_group_dependencies(group_name) -%}
+    {%- set deps_result = [] -%}
+    {%- set group = feature_to_dev_dependencies[group_name] -%}
+    {%- for dep, required_features in group.items() -%}
+        {%- if required_features | length == 0 or required_features | is_in(template.built_in_features) -%}
+            {%- set _ = deps_result.append(dep) -%}
+        {%- endif -%}
+    {%- endfor -%}
+    {%- for dep in deps_result %}
+    "{{ dep }}",
+    {% endfor -%}
+{%- endmacro -%}
+{% set release_deps = get_dev_group_dependencies("release") %}
+{% set lint_deps = get_dev_group_dependencies("lint") %}
+{% set test_deps = get_dev_group_dependencies("test") %}
+[project]
+name = "{{ general.slug }}"
+version = "{{ general.version }}"
+description = "{{ general.description }}"
+authors = [{name = "{{ general.author }}", email = "{{ git.email }}"}]
+dependencies = [
+{{ get_main_dependencies() }}]
+requires-python = "=={{ general.python_version }}.*"
+readme = "README.md"
+license = { file = "LICENSE" }
+
+{% if general.dependency_manager == "pdm" %}
+[tool.pdm]
+distribution = false
+{% endif %}
+{% if release_deps.strip() or lint_deps.strip() or test_deps.strip() %}
+[dependency-groups]
+{% if release_deps.strip() %}
+release = [
+{{ release_deps }}]
+{% endif %}
+{% if lint_deps.strip() %}
+lint = [
+{{ lint_deps }}]
+{% endif %}
+{% if test_deps.strip() %}
+test = [
+{{ test_deps }}]
+{% endif %}
+{% endif %}
+
+{% if dependencies | has_dependency("ruff") or has_github_actions_or_makefile %}
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "B", "C4", "UP", "I"]
+ignore = ["B008"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["{{ general.source_name }}", "test"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+{% endif %}
+
+{% if "github_actions" in template.built_in_features %}
+[project.optional-dependencies]
+build = ["uv>=0.7.21"]
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+commit_message = "bump: new version {version} created"
+commit_parser = "conventional"
+major_on_zero = false
+allow_zero_version = true
+no_git_verify = false
+tag_format = "{version}"
+build_command = """
+    pip install -e '.[build]'
+    {{ general.dependency_manager }} lock --upgrade-package {{ general.slug }}
+    git add {{ general.dependency_manager }}.lock
+"""
+
+[tool.semantic_release.commit_parser_options]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf", "refactor", "test", "build"]
+allowed_tags = ["feat", "fix", "refactor", "perf", "build"]
+default_bump_level = 0
+parse_squash_commits = false
+ignore_merge_commits = true
+
+[tool.semantic_release.changelog]
+changelog_file = "CHANGELOG.md"
+exclude_commit_patterns = ['''^Merge pull request #''', '''^Merge branch ''']
+mode = "update"
+#template_dir = "docs/changelog"
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG"
+output_format = "md"
+mask_initial_release = false
+{% endif %}

instant_python/templates/boilerplate/pytest.ini

@@ -0,0 +1,10 @@
+[pytest]
+markers =
+    unit: mark a test as a unit test
+    acceptance: mark a test as an acceptance test
+    integration: mark a test as an integration test
+testpaths =
+    test
+asyncio_default_fixture_loop_scope =
+    function
+asyncio_mode = auto

instant_python/templates/boilerplate/scripts/add_dependency.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+import subprocess
+
+{% if general.dependency_manager == "pdm" -%}
+def main() -> None:
+  dependency = input("Dependency to install: ")
+  is_dev = input(f"Do you want to install {dependency} as a dev dependency? (y/n): ")
+  add_to_group = input(
+    f"Do you want to install the {dependency} inside a group? (y/n): "
+  )
+
+  dev_flag = ""
+  group_flag = ""
+  if is_dev.lower() == "y":
+    dev_flag = "--dev"
+  if add_to_group.lower() == "y":
+    group_name = input("Group name: ")
+    group_flag = f"--group {group_name}"
+
+  cmd = f"pdm add {dev_flag} {group_flag} {dependency}".strip()
+  subprocess.run(cmd, shell=True, check=True)
+
+{%- elif general.dependency_manager == "uv" -%}
+def main() -> None:
+  dependency = input("Dependency to install: ")
+  is_dev = input(f"Do you want to install {dependency} as a dev dependency? (y/n): ")
+  add_to_group = input(
+    f"Do you want to install the {dependency} inside a group? (y/n): "
+  )
+
+  flag = ""
+  if is_dev.lower() == "y":
+    flag = "-d"
+  if add_to_group.lower() == "y":
+    group_name = input("Group name: ")
+    flag = f"-G {group_name}"
+
+  cmd = f"uv add {flag} {dependency}".strip()
+  subprocess.run(cmd, shell=True, check=True)
+{%- endif %}
+
+
+if __name__ == "__main__":
+  main()
+

instant_python/templates/boilerplate/scripts/create_aggregate.py

@@ -0,0 +1,33 @@
+from pathlib import Path
+
+def create_package_structure(base_dir: str, context: str, aggregate: str) -> None:
+	"""Create the folder structure and __init__.py files for the given context and aggregate."""
+	context_base_path = Path(base_dir, "contexts", context)
+	aggregate_base_path = context_base_path / aggregate
+
+	dirs_to_create = [
+		context_base_path,
+		aggregate_base_path,
+		aggregate_base_path / "application",
+		aggregate_base_path / "domain",
+		aggregate_base_path / "infra",
+	]
+
+	for directory in dirs_to_create:
+		directory.mkdir(parents=True, exist_ok=True)
+		init_file = directory / "__init__.py"
+		if not init_file.exists():
+			init_file.touch()
+
+def main() -> None:
+	context = input("Enter the name of the bounded context: ").strip()
+	aggregate = input("Enter the name of the new aggregate: ").strip()
+
+	create_package_structure("instant_python", context, aggregate)
+	create_package_structure("tests", context, aggregate)
+
+	print(f"Successfully created the aggregate '{aggregate}' under context '{context}'.")
+
+
+if __name__ == "__main__":
+	main()