Автоматическое создание скриптов на Python: инструменты и методики

Генерация класса с конструктором и методами через AST

Создадим класс Person с атрибутами имени и возраста, а также методом greet.

import ast

# Конструируем класс
class_def = ast.ClassDef(
    name='Person',
    bases=[],
    keywords=[],
    body=[
        # Метод __init__
        ast.FunctionDef(
            name='__init__',
            args=ast.arguments(
                posonlyargs=[],
                args=[ast.arg(arg='self'), ast.arg(arg='name'), ast.arg(arg='age')],
                kwonlyargs=[],
                kw_defaults=[],
                defaults=[]
            ),
            body=[
                ast.Assign(
                    targets=[ast.Attribute(value=ast.Name(id='self', ctx=ast.Load()), attr='name', ctx=ast.Store())],
                    value=ast.Name(id='name', ctx=ast.Load())
                ),
                ast.Assign(
                    targets=[ast.Attribute(value=ast.Name(id='self', ctx=ast.Load()), attr='age', ctx=ast.Store())],
                    value=ast.Name(id='age', ctx=ast.Load())
                )
            ],
            decorator_list=[]
        ),
        # Метод greet
        ast.FunctionDef(
            name='greet',
            args=ast.arguments(
                posonlyargs=[],
                args=[ast.arg(arg='self')],
                kwonlyargs=[],
                kw_defaults=[],
                defaults=[]
            ),
            body=[
                ast.Return(
                    value=ast.Call(
                        func=ast.Attribute(value=ast.Constant(value='Hello, my name is '), attr='format', ctx=ast.Load()),
                        args=[ast.Attribute(value=ast.Name(id='self', ctx=ast.Load()), attr='name', ctx=ast.Load())],
                        keywords=[]
                    )
                )
            ],
            decorator_list=[]
        )
    ],
    decorator_list=[]
)

# Преобразуем в строку
code = ast.unparse(class_def)
print(code)

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def greet(self):
        return 'Hello, my name is '.format(self.name)

Результат – валидный Python-класс, готовый к выполнению.

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

Создадим шаблон декоратора с использованием f-строк и текстового шаблона.

import textwrap

def generate_timer_decorator(import_time=True):
    parts = []
    if import_time:
        parts.append('import time')
    parts.append('')
    parts.append('def timer(func):')
    parts.append('    def wrapper(*args, **kwargs):')
    parts.append('        start = time.time()')
    parts.append('        result = func(*args, **kwargs)')
    parts.append('        end = time.time()')
    parts.append('        print(f"Function {func.__name__} took {end-start:.4f} sec")')
    parts.append('        return result')
    parts.append('    return wrapper')
    return textwrap.dedent('\n'.join(parts))

code = generate_timer_decorator(import_time=True)
print(code)

import time

def timer(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print(f"Function {func.__name__} took {end-start:.4f} sec")
        return result
    return wrapper

Этот код можно сразу сохранить в файл decorators.py и импортировать.

Генерация кода для Flask-эндпоинта на основе конфигурации

Используем Jinja2 для создания REST-обработчика.

from jinja2 import Template

route_template = Template('''
@app.route('{{ path }}', methods=[{{ methods | map('quote') | join(', ') }}])
def {{ func_name }}({{ params }}):
    """{{ doc }}"""
    # TODO: implement
    return {{ response }}
''')

config = {
    'path': '/api/users/',
    'methods': ['GET', 'PUT'],
    'func_name': 'user_detail',
    'params': 'user_id',
    'doc': 'Get or update user by ID',
    'response': '{"message": "ok"}'
}

code = route_template.render(config)
print(code)

@app.route('/api/users/', methods=['GET', 'PUT'])
def user_detail(user_id):
    """Get or update user by ID"""
    # TODO: implement
    return {"message": "ok"}

Так можно автоматически сгенерировать весь набор эндпоинтов, если есть список конфигураций.

Использование inspect для воссоздания функции из существующей сигнатуры

Иногда требуется сгенерировать код, эквивалентный уже существующей функции, но с изменёнными именами.

import inspect

def original_function(a, b: int = 10, *args, **kwargs) -> float:
    """Original docstring."""
    return a + b

# Получаем сигнатуру
sig = inspect.signature(original_function)
source = inspect.getsource(original_function)

# Создаём новую функцию с другим именем
new_name = 'new_function'
new_source = source.replace('original_function', new_name)
new_source = new_source.replace('Original docstring.', 'Generated copy.')

print(new_source)

def new_function(a, b: int = 10, *args, **kwargs) -> float:
    """Generated copy."""
    return a + b

Этот приём полезен для кодогенерации на основе рефлексии, например, при создании ORM-моделей.