common-python-tasks 0.5.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

common_python_tasks/data/fastapi/alembic.ini.j2

@@ -5,16 +5,15 @@ prepend_sys_path = .
 output_encoding = utf-8
 
 [post_write_hooks]
-hooks = black,isort
+hooks = ruff_check,ruff_format
 
-black.type = console_scripts
-black.entrypoint = black
+ruff_check.type = exec
+ruff_check.executable = ruff
+ruff_check.options = check --fix-only --select F401,I REVISION_SCRIPT_FILENAME
 
-autoflake.type = console_scripts
-autoflake.entrypoint = autoflake
-
-isort.type = console_scripts
-isort.entrypoint = isort
+ruff_format.type = exec
+ruff_format.executable = ruff
+ruff_format.options = format REVISION_SCRIPT_FILENAME
 
 # Logging configuration
 [loggers]

common_python_tasks/data/generic/ruff.toml

@@ -0,0 +1,6 @@
+line-length = 88
+extend-exclude = [".dist", ".poetry", "build"]
+
+[lint]
+select = ["E4", "E7", "E9", "F", "I", "W"]
+ignore = ["W191"]

common_python_tasks/docker.py

@@ -190,7 +190,7 @@ def prune_images_keep(
         if line not in lines
     ]
 
-    tags_in_order: list[str] = []
+    tags_in_order = []
     seen_tags: set[str] = set()
     for entry in lines:
         try:
@@ -509,7 +509,7 @@ def build_image(
             for t in tags_to_use
         ]
 
-        all_tags: list[str] = []
+        all_tags = []
         for resolved_tag in [*short_tags, *full_tags]:
             if resolved_tag not in all_tags:
                 all_tags.append(resolved_tag)

common_python_tasks/docker_compose.py

@@ -414,8 +414,8 @@ def load_compose_files(
         )
     ]
 
-    temp_config_files: list[Path] = []
-    addon_template_vars: dict[str, dict[str, str]] = {}
+    temp_config_files = []
+    addon_template_vars = {}
 
     if "db" in compose_addons and compose_type == "fastapi":
         alembic_path, alembic_cleanup = ensure_alembic_config(compose_type)

common_python_tasks/git.py

@@ -185,7 +185,7 @@ def infer_bump_component_from_git_cliff() -> ReleaseComponent:
     try:
         current = Version.parse(current_version)
     except Exception:
-        utils.fatal("Unable to parse current project version: " f"{current_version!r}")
+        utils.fatal(f"Unable to parse current project version: {current_version!r}")
 
     def _parse_semver(version_value: str | Any) -> tuple[int, int, int]:
         if not isinstance(version_value, str):

common_python_tasks/github.py

@@ -344,6 +344,52 @@ def github_api_request(
     return GitHubClient().api_request(method, path, payload=payload)
 
 
+def create_pull_request(
+    title: str,
+    head: str,
+    base: str,
+    body: str | None = None,
+    draft: bool = False,
+) -> dict[str, Any] | None:
+    """Create a GitHub pull request for the current repository.
+
+    Args:
+        title: Pull request title.
+        head: Source branch name.
+        base: Base branch name.
+        body: Optional pull request body.
+        draft: Whether to create the pull request as a draft.
+
+    Returns:
+        The GitHub API response for the created pull request, or `None` when
+        repository information is unavailable.
+    """
+    repository = get_github_repository()
+    token = get_github_token()
+
+    if repository is None:
+        LOGGER.debug(
+            "Skipping pull request creation because this is not a GitHub repository"
+        )
+        return None
+    if token is None:
+        utils.fatal(
+            "GITHUB_TOKEN or GH_TOKEN environment variable must be set to open a GitHub pull request"
+        )
+
+    return GitHubClient(repository=repository, token=token).api_request(
+        "POST",
+        "/pulls",
+        payload={
+            "title": title,
+            "head": head,
+            "base": base,
+            "body": body or "",
+            "draft": draft,
+        },
+    )
+
+
 def publish_github_release(
     tag_name: str,
     release_name: str | None = None,
@@ -388,7 +434,7 @@ def publish_github_release(
     release_name = release_name or tag_name
     release_body = body if body is not None else _changelog()
     if release_body is not None and _is_unreleased_placeholder(release_body):
-        LOGGER.info(
+        LOGGER.debug(
             "git-cliff returned an unreleased placeholder; using latest tagged release notes instead"
         )
         release_body = _latest_tagged_changelog()
@@ -497,7 +543,7 @@ def get_github_release_asset_paths(
         else:
             source_items = ["dist/*"]
 
-    asset_paths: list[Path] = []
+    asset_paths = []
     for part in source_items:
         if any(char in part for char in "*?[]"):
             asset_paths.extend(
@@ -589,7 +635,7 @@ def upload_github_release_assets(
     Returns:
         A list of decoded JSON responses for the uploaded assets.
     """
-    uploaded_assets: list[dict[str, Any]] = []
+    uploaded_assets = []
     for asset_path in asset_paths:
         LOGGER.info("Uploading GitHub Release asset: %s", asset_path)
         uploaded = upload_github_release_asset(release_id, asset_path)

common_python_tasks/project.py

@@ -8,9 +8,9 @@ from enum import StrEnum, auto
 from functools import lru_cache
 from importlib import metadata
 from pathlib import Path
-from typing import Any
+from typing import Any, Sequence
 
-from packaging.specifiers import SpecifierSet
+from packaging.specifiers import InvalidSpecifier, SpecifierSet
 from packaging.version import Version
 
 from . import utils
@@ -123,7 +123,7 @@ def get_package_manager() -> PackageManager:
     override = _find_package_manager_override()
     if override is None:
         package_manager, reason = _resolve_package_manager_auto()
-        LOGGER.info(
+        LOGGER.debug(
             "Using package manager backend: %s (%s)",
             package_manager,
             reason,
@@ -133,12 +133,12 @@ def get_package_manager() -> PackageManager:
     env_var, raw_value = override
     if raw_value not in PackageManager:
         utils.fatal(
-            f"Invalid {env_var} value {raw_value!r}. " "Use one of: poetry, uv, auto."
+            f"Invalid {env_var} value {raw_value!r}. Use one of: poetry, uv, auto."
         )
 
     if raw_value == PackageManager.AUTO:
         package_manager, reason = _resolve_package_manager_auto()
-        LOGGER.info(
+        LOGGER.debug(
             "Using package manager backend: %s (%s via %s=%s)",
             package_manager,
             reason,
@@ -149,7 +149,7 @@ def get_package_manager() -> PackageManager:
 
     package_manager = PackageManager(raw_value)
     _ensure_package_manager_available(package_manager)
-    LOGGER.info(
+    LOGGER.debug(
         "Using package manager backend: %s (from %s)",
         package_manager,
         env_var,
@@ -179,14 +179,62 @@ def get_package_manager_build_command(wheel_only: bool = False) -> list[str]:
     return command
 
 
-def get_package_manager_publish_command() -> list[str]:
+def get_package_manager_update_command(
+    dependencies: Sequence[str] | None = None,
+) -> list[str]:
+    """Return the dependency update command for the selected package manager.
+
+    Args:
+        dependencies: Optional dependency names to update. When omitted, all
+            dependencies are updated.
+
+    Returns:
+        Command tokens for the dependency update command.
+    """
+    if dependencies is None:
+        dependencies = []
+
+    package_manager = PackageManager(get_package_manager())
+    if package_manager == PackageManager.UV:
+        command = ["uv", "sync", "--upgrade"]
+        for dependency in dependencies:
+            command.extend(["--upgrade-package", dependency])
+        return command
+
+    return ["poetry", "update", *dependencies]
+
+
+def get_package_manager_publish_command(
+    repository: str | None = None,
+    repository_url: str | None = None,
+) -> list[str]:
     """Return the publish command for the selected package manager.
 
+    Args:
+        repository: Optional configured repository name to publish to.
+        repository_url: Optional repository upload URL to publish to.
+
     Returns:
         Command tokens for the package publish command.
     """
+    if repository is not None and repository_url is not None:
+        utils.fatal("Specify either `repository` or `repository_url`, not both.")
+
     package_manager = PackageManager(get_package_manager())
-    return [package_manager.value, "publish"]
+    command = [package_manager.value, "publish"]
+    if repository_url is not None:
+        if package_manager == PackageManager.POETRY:
+            utils.fatal(
+                "Poetry publish only supports configured repository names. "
+                "Pass `repository` instead of `repository_url`."
+            )
+        command += ["--publish-url", repository_url]
+    elif repository is not None:
+        if package_manager == PackageManager.UV:
+            command += ["--index", repository]
+        else:
+            command += ["-r", repository]
+    return command
 
 
 @lru_cache
@@ -381,7 +429,7 @@ def read_pyproject_toml() -> dict[str, Any]:
     return tomllib.loads(Path("pyproject.toml").read_text())
 
 
-BLACK_TARGET_PYTHON_MINORS = range(7, 17)
+RUFF_TARGET_PYTHON_MINORS = range(7, 16)
 
 
 def _specifier_supports_python_minor(specifier_set: SpecifierSet, minor: int) -> bool:
@@ -390,11 +438,11 @@ def _specifier_supports_python_minor(specifier_set: SpecifierSet, minor: int) ->
     )
 
 
-def get_black_target_version() -> str | None:
-    """Return the Black target-version token based on `project.requires-python`.
+def get_ruff_target_version() -> str | None:
+    """Return the Ruff target-version token based on `project.requires-python`.
 
     Returns:
-        The lowest supported Python version in Black format, such as
+        The lowest supported Python version in Ruff format, such as
         `py311`, or `None` when the project metadata is missing or invalid.
     """
     requires_python = read_pyproject_toml().get("project", {}).get("requires-python")
@@ -403,13 +451,13 @@ def get_black_target_version() -> str | None:
 
     try:
         specifier_set = SpecifierSet(requires_python)
-    except Exception:
+    except InvalidSpecifier:
         LOGGER.warning("Unable to parse requires-python specifier: %s", requires_python)
         return None
 
-    for minor in BLACK_TARGET_PYTHON_MINORS:
+    for minor in RUFF_TARGET_PYTHON_MINORS:
         if _specifier_supports_python_minor(specifier_set, minor):
-            return f"py3{minor:02d}"
+            return f"py3{minor}"
     return None
 
 
@@ -592,7 +640,7 @@ def get_project_version_from_poetry() -> str:
     parts = poetry_version_output.rsplit(" ", 1)
     if len(parts) != 2 or not parts[1].strip():
         utils.fatal(
-            "Unexpected poetry version output format: " f"{poetry_version_output!r}"
+            f"Unexpected poetry version output format: {poetry_version_output!r}"
         )
     return parts[1].strip()