Создание скриптов для автоматизации управления проектами на Python

Как выполнить консольные команды без установки дополнительных библиотек?

Стандартный модуль subprocess позволяет запускать внешние процессы и получать их вывод. Создадим скрипт run.py с функциями, вызывающими pip, pytest, flake8.

import subprocess
import sys

def install():
    result = subprocess.run([sys.executable, "-m", "pip", "install", "-r", "requirements.txt"], capture_output=True, text=True)
    if result.returncode == 0:
        print("Установка завершена успешно")
    else:
        print("Ошибка установки:", result.stderr)

def test():
    result = subprocess.run([sys.executable, "-m", "pytest", "--cov=src", "tests/"], capture_output=True, text=True)
    print(result.stdout)
    if result.returncode != 0:
        print("Некоторые тесты не прошли")

def lint():
    result = subprocess.run(["flake8", "src/", "tests/"], capture_output=True, text=True)
    if result.returncode == 0:
        print("Линтинг пройден")
    else:
        print("Найдены проблемы:", result.stdout)

Run python project (запуск проекта python)

Для вызова нужной функции добавьте блок if __name__ == "__main__": и разбор аргументов из sys.argv.

Цели использования: минимальные требования (только стандартная библиотека), подходит для простых проектов без внешних зависимостей.

Как создать универсальный инструмент с выбором действий и параметрами?

Модуль argparse позволяет парсить аргументы командной строки. Создадим manage.py с подкомандами.

import argparse
import subprocess
import sys

def install():
    subprocess.run([sys.executable, "-m", "pip", "install", "-r", "requirements.txt"])

def test(verbose=False):
    cmd = [sys.executable, "-m", "pytest", "tests/"]
    if verbose:
        cmd.append("-v")
    subprocess.run(cmd)

def lint():
    subprocess.run(["flake8", "src/", "tests/"])

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Управление проектом")
    subparsers = parser.add_subparsers(dest="command", required=True)
    parser_install = subparsers.add_parser("install", help="Установка зависимостей")
    parser_test = subparsers.add_parser("test", help="Запуск тестов")
    parser_test.add_argument("-v", "--verbose", action="store_true", help="Подробный вывод")
    parser_lint = subparsers.add_parser("lint", help="Линтинг")

    args = parser.parse_args()
    if args.command == "install":
        install()
    elif args.command == "test":
        test(verbose=args.verbose)
    elif args.command == "lint":
        lint()

Запуск: python manage.py install, python manage.py test -v.

Цели использования: когда нужен полноценный CLI с документацией, подсказками и опциями. Подходит для скриптов, которые будут использоваться другими разработчиками.

Как упростить создание CLI с помощью декораторов?

Библиотека click предоставляет более элегантный декларативный подход. Установка: pip install click.

import click
import subprocess
import sys

@click.group()
def cli():
    """Управление проектом"""
    pass

@cli.command()
def install():
    """Установка зависимостей"""
    subprocess.run([sys.executable, "-m", "pip", "install", "-r", "requirements.txt"])

@cli.command()
@click.option("-v", "--verbose", is_flag=True, help="Подробный вывод")
def test(verbose):
    """Запуск тестов"""
    cmd = [sys.executable, "-m", "pytest", "tests/"]
    if verbose:
        cmd.append("-v")
    subprocess.run(cmd)

@cli.command()
def lint():
    """Линтинг"""
    subprocess.run(["flake8", "src/", "tests/"])

if __name__ == "__main__":
    cli()

Запуск: python app.py install, python app.py test --verbose.

Цели использования: когда нужно быстро создать красивое CLI с поддержкой групп команд, опций и автоматической генерации справки. click рекомендуется для средних и больших проектов.

Как автоматически тестировать код в нескольких версиях Python и с разными зависимостями?

Инструмент nox (аналог tox) позволяет определить сессии в файле noxfile.py. Каждая сессия может использовать разные версии Python и окружения.

import nox

@nox.session(python=["3.9", "3.10", "3.11"])
def tests(session):
    session.install(".[test]")  # установка зависимостей из test extras
    session.run("pytest", "--cov=src")

@nox.session(python="3.11")
def lint(session):
    session.install("flake8")
    session.run("flake8", "src", "tests")

@nox.session
def docs(session):
    session.install(".[docs]")
    session.run("sphinx-build", "-b", "html", "docs", "docs/_build")

Запуск: nox -s tests (тестирование всех версий), nox -s lint.

Цели использования: когда проект должен поддерживать несколько версий Python, или нужно тестировать разные варианты зависимостей. Используется в CI/CD.

Как выполнять задачи на удаленных серверах (деплой, администрирование)?

Fabric (версия 2.x) позволяет писать скрипты для удаленного выполнения команд через SSH. Создайте fabfile.py.

from fabric import Connection, task

@task
def deploy(c):
    """Деплой на продакшн"""
    conn = Connection("user@host")
    with conn.cd("/var/www/myproject"):
        conn.run("git pull origin main")
        conn.run("pip install -r requirements.txt")
        conn.run("python manage.py migrate")
        conn.run("supervisorctl restart myproject")
    print("Деплой завершен")

@task
def status(c):
    """Статус сервера"""
    conn = Connection("user@host")
    conn.run("systemctl status myproject")

Запуск: fab deploy (с установленным fabric, установка: pip install fabric).

Цели использования: автоматизация деплоя, перезапуска служб, сбора логов на одном или нескольких серверах.