InvenTree: массовое создание мест хранения через Python API

#!/usr/bin/env python3
"""Создание подлокаций Schublade под локацией Apothekerschrank в InvenTree.

Этот скрипт подключается к экземпляру InvenTree через REST API и создаёт
набор подлокаций типа "Schublade" под родительской локацией
"Apothekerschrank". Для каждого из трёх рядов A, B и C создаёт ящики
с номерами от 1 до 19, всего 57 подлокаций. Каждой подлокации
назначается тип места хранения "Schublade".

Скрипт идемпотентен: если подлокация уже существует под родителем,
она пропускается, а не дублируется.

Конфигурация читается из ``config.yaml`` в том же каталоге:

.. code-block:: yaml

    inventree:
      server: https://inventree.example.com
      token: your-api-token-here

Требования:
    - Python 3.8+
    - requests
    - PyYAML

Использование::

    python3 create_locations.py
"""

import sys
import requests
import yaml
from pathlib import Path

# Путь к YAML-файлу конфигурации, ожидается рядом с этим скриптом.
CONFIG_PATH = Path(__file__).parent / "config.yaml"


def load_config():
    """Загрузка настроек подключения InvenTree из ``config.yaml``.

    Возвращает словарь с ключами ``server`` и ``token``.
    """
    with open(CONFIG_PATH, "r") as f:
        return yaml.safe_load(f)["inventree"]


class InvenTreeAPI:
    """Минимальный REST API клиент для InvenTree.

    Оборачивает :mod:`requests` с токен-аутентификацией и удобными
    методами для GET и POST запросов к API InvenTree.
    """

    def __init__(self, server, token):
        """Инициализация API-клиента.

        :param server: Базовый URL экземпляра InvenTree, например
            ``https://inventree.example.com``.
        :param token: API-токен аутентификации (создаётся в
            веб-интерфейсе InvenTree в *Settings > API Keys*).
        """
        self.server = server.rstrip("/")
        self.token = token
        self.session = requests.Session()
        self.session.headers.update({
            "Authorization": f"Token {token}",
            "Content-Type": "application/json",
        })

    def get(self, path, params=None):
        """Выполняет GET-запрос и возвращает разобранный JSON-ответ."""
        r = self.session.get(f"{self.server}{path}", params=params)
        r.raise_for_status()
        return r.json()

    def post(self, path, data):
        """Выполняет POST-запрос с JSON-телом и возвращает разобранный ответ."""
        r = self.session.post(f"{self.server}{path}", json=data)
        if r.status_code == 400:
            print(f"  ERROR 400: {r.json()}")
        r.raise_for_status()
        return r.json()


def find_location_type(api, name):
    """Поиск типа места хранения по имени.

    Перебирает все типы мест через постраничные вызовы API.
    Возвращает первичный ключ (``pk``), если найден, иначе ``None``.
    """
    offset = 0
    while True:
        data = api.get("/api/stock/location-type/", params={"limit": 100, "offset": offset})
        results = data if isinstance(data, list) else data.get("results", [])
        for t in results:
            if t["name"] == name:
                return t["pk"]
        if isinstance(data, list) or not data.get("next"):
            break
        offset += 100
    return None


def find_location(api, name):
    """Поиск места хранения по имени среди всех мест.

    Перебирает все места хранения через постраничные вызовы API.
    Возвращает первичный ключ (``pk``), если найден, иначе ``None``.
    """
    offset = 0
    while True:
        data = api.get("/api/stock/location/", params={"limit": 100, "offset": offset})
        for loc in data["results"]:
            if loc["name"] == name:
                return loc["pk"]
        if not data["next"]:
            break
        offset += 100
    return None


def find_child_location(api, parent_pk, name):
    """Поиск дочернего места хранения по имени под заданным родителем.

    Запрашивает через API все места, у которых ``parent`` равен
    ``parent_pk``, и возвращает ``pk`` первого совпадения, либо ``None``.
    """
    results = api.get("/api/stock/location/", params={
        "parent": parent_pk, "limit": 1000
    })
    loc_list = results if isinstance(results, list) else results.get("results", [])
    for loc in loc_list:
        if loc["name"] == name:
            return loc["pk"]
    return None


def main():
    """Точка входа: поиск родительской локации, проверка типа, создание подлокаций."""
    config = load_config()
    api = InvenTreeAPI(config["server"], config["token"])

    # --- Поиск или создание типа места хранения "Schublade" ---
    # InvenTree поддерживает пользовательские типы мест, которые можно
    # назначать отдельным местам хранения. Используем существующий тип,
    # если он есть.
    schublade_type_pk = find_location_type(api, "Schublade")
    if schublade_type_pk:
        print(f"Location type 'Schublade' found (pk={schublade_type_pk})")
    else:
        result = api.post("/api/stock/location-type/", {
            "name": "Schublade",
            "description": "Schublade im Apothekerschrank",
            "icon": "ti:box:outline",
        })
        schublade_type_pk = result["pk"]
        print(f"Location type 'Schublade' created (pk={schublade_type_pk})")

    # --- Поиск родительской локации "Apothekerschrank" ---
    # Эта локация должна уже существовать в InvenTree. Скрипт завершится
    # с ошибкой, если её не удастся найти.
    apotheker_pk = find_location(api, "Apothekerschrank")
    if not apotheker_pk:
        print("ERROR: Location 'Apothekerschrank' not found")
        sys.exit(1)
    print(f"Location 'Apothekerschrank' found (pk={apotheker_pk})")

    # --- Создание подлокаций: Schublade A1..A19, B1..B19, C1..C19 ---
    # Каждая подлокация создаётся как дочерняя по отношению к локации
    # Apothekerschrank и получает тип места "Schublade". Существующие
    # места пропускаются для идемпотентности скрипта.
    created = 0
    skipped = 0
    for letter in ["A", "B", "C"]:
        for number in range(1, 20):
            name = f"Schublade {letter}{number}"
            existing = find_child_location(api, apotheker_pk, name)
            if existing:
                print(f"  Skipped (exists): {name} (pk={existing})")
                skipped += 1
                continue
            result = api.post("/api/stock/location/", {
                "name": name,
                "parent": apotheker_pk,
                "location_type": schublade_type_pk,
            })
            print(f"  Created: {name} (pk={result['pk']})")
            created += 1

    print(f"\nDone: {created} created, {skipped} skipped")


if __name__ == "__main__":
    main()