InvenTree: Hromadné vytváření skladových míst pomocí Python API skriptu

#!/usr/bin/env python3
"""Vytvoření podlokalizací Schublade pod lokací Apothekerschrank v InvenTree.

Tento skript se připojuje k instanci InvenTree přes REST API a vytváří
sadu podlokalizací typu šuplík (\"Schublada\") pod nadřazenou lokalitou
s názvem \"Apothekerschrank\". Pro každý ze tří řad A, B a C vytvoří
šuplíky očíslované 1 až 19, celkem 57 podlokalizací.
Každé podlokalizaci je přiřazen typ skladového místa \"Schublade\".

Skript je idempotentní: pokud podlokalizace pod nadřazenou lokalitou
již existuje, je přeskočena, nikoli duplikována.

Konfigurace se načítá z ``config.yaml`` ve stejném adresáři:

.. code-block:: yaml

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

Požadavky:
    - Python 3.8+
    - requests
    - PyYAML

Použití::

    python3 create_locations.py
"""

import sys
import requests
import yaml
from pathlib import Path

# Cesta ke konfiguračnímu souboru YAML, očekávaná vedle tohoto skriptu.
CONFIG_PATH = Path(__file__).parent / "config.yaml"


def load_config():
    """Načte nastavení připojení k InvenTree z ``config.yaml``.

    Vrací dict s klíči ``server`` a ``token``.
    """
    with open(CONFIG_PATH, "r") as f:
        return yaml.safe_load(f)["inventree"]


class InvenTreeAPI:
    """Minimální REST API klient pro InvenTree.

    Obaluje :mod:`requests` s autentizací pomocí tokenu a pohodlnými
    metodami pro GET a POST volání na API InvenTree.
    """

    def __init__(self, server, token):
        """Inicializuje API klienta.

        :param server: Base URL instance InvenTree, např.
            ``https://inventree.example.com``.
        :param token: Autentizační token API (vygenerujte si ho
            ve webovém rozhraní InvenTree v *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):
        """Provede GET požadavek a vrátí parsovanou JSON odpověď."""
        r = self.session.get(f"{self.server}{path}", params=params)
        r.raise_for_status()
        return r.json()

    def post(self, path, data):
        """Provede POST požadavek s JSON tělem a vrátí parsovanou odpověď."""
        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):
    """Najde typ skladového místa podle názvu.

    Prochází všechny typy lokalizací přes paginovaná API volání.
    Vrací primární klíč (``pk``) pokud je nalezen, jinak ``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):
    """Najde skladové místo podle názvu napříč všemi lokalizacemi.

    Prochází všechna skladová místa přes paginovaná API volání.
    Vrací primární klíč (``pk``) pokud je nalezen, jinak ``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):
    """Najde podřízené skladové místo podle názvu pod daným nadřazeným.

    Dotazuje API na všechny lokality, jejichž ``parent`` odpovídá
    ``parent_pk`` a vrátí ``pk`` první shody, nebo ``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():
    """Hlavní vstupní bod: najít nadřazenou lokalitu, zajistit typ lokality, vytvořit podlokalizace."""
    config = load_config()
    api = InvenTreeAPI(config["server"], config["token"])

    # --- Najít nebo vytvořit typ skladového místa "Schublade" ---
    # InvenTree podporuje uživatelsky definované typy lokalizací, které lze přiřadit
    # jednotlivým skladovým místům. Pokud typ již existuje, použijeme ho.
    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})")

    # --- Najít nadřazenou lokalitu "Apothekerschrank" ---
    # Tato lokalita musí v InvenTree již existovat. Skript se ukončí
    # s chybou, pokud ji nelze najít.
    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})")

    # --- Vytvořit podlokalizace: Schublade A1..A19, B1..B19, C1..C19 ---
    # Každá podlokalizace je vytvořena jako potomek lokality Apothekerschrank
    # a je jí přiřazen typ lokality "Schublade". Lokality, které již
    # existují, jsou přeskočeny, aby skript zůstal idempotentní.
    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()