InvenTree: crear ubicaciones de stock en lote mediante scripting con la API en Python

#!/usr/bin/env python3
"""Crea sububicaciones Schublade bajo una ubicación Apothekerschrank en InvenTree.

Este script se conecta a una instancia de InvenTree mediante la REST API y crea
un conjunto de sububicaciones de cajones ("Schublade") bajo una ubicación padre
llamada "Apothekerschrank". Para cada una de las tres filas A, B y C, crea
cajones numerados del 1 al 19, obteniendo un total de 57 sububicaciones.
Cada sububicación recibe el tipo de ubicación de stock "Schublade".

El script es idempotente: si una sububicación ya existe bajo el padre,
se omite en lugar de duplicarse.

La configuración se lee desde ``config.yaml`` en el mismo directorio:

.. code-block:: yaml

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

Requisitos:
    - Python 3.8+
    - requests
    - PyYAML

Uso::

    python3 create_locations.py
"""

import sys
import requests
import yaml
from pathlib import Path

# Ruta al archivo de configuración YAML, esperado junto a este script.
CONFIG_PATH = Path(__file__).parent / "config.yaml"


def load_config():
    """Carga los ajustes de conexión a InvenTree desde ``config.yaml``.

    Devuelve un dict con las claves ``server`` y ``token``.
    """
    with open(CONFIG_PATH, "r") as f:
        return yaml.safe_load(f)["inventree"]


class InvenTreeAPI:
    """Cliente REST API minimalista para InvenTree.

    Envuelve :mod:`requests` con autenticación basada en token y métodos
    de conveniencia para llamadas GET y POST contra la API de InvenTree.
    """

    def __init__(self, server, token):
        """Inicializa el cliente de la API.

        :param server: URL base de la instancia de InvenTree, p. ej.
            ``https://inventree.example.com``.
        :param token: Token de autenticación de la API (genera uno en la
            interfaz web de InvenTree en *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):
        """Realiza una petición GET y devuelve la respuesta JSON parseada."""
        r = self.session.get(f"{self.server}{path}", params=params)
        r.raise_for_status()
        return r.json()

    def post(self, path, data):
        """Realiza una petición POST con un body JSON y devuelve la respuesta parseada."""
        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):
    """Busca un tipo de ubicación de stock por nombre.

    Recorre todos los tipos de ubicación mediante llamadas paginadas a la API.
    Devuelve la clave primaria (``pk``) si se encuentra, en caso contrario ``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):
    """Busca una ubicación de stock por nombre entre todas las ubicaciones.

    Recorre todas las ubicaciones de stock mediante llamadas paginadas a la API.
    Devuelve la clave primaria (``pk``) si se encuentra, en caso contrario ``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):
    """Busca una ubicación de stock hija por nombre bajo un padre dado.

    Consulta la API para todas las ubicaciones cuyo ``parent`` coincide con
    ``parent_pk`` y devuelve el ``pk`` de la primera coincidencia, o ``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():
    """Punto de entrada principal: busca la ubicación padre, asegura el tipo de ubicación, crea las sububicaciones."""
    config = load_config()
    api = InvenTreeAPI(config["server"], config["token"])

    # --- Buscar o crear el tipo de ubicación de stock "Schublade" ---
    # InvenTree soporta tipos de ubicación definidos por el usuario que pueden
    # asignarse a ubicaciones de stock individuales. Reutilizamos un tipo
    # existente si está presente.
    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})")

    # --- Buscar la ubicación padre "Apothekerschrank" ---
    # Esta ubicación debe existir previamente en InvenTree. El script
    # terminará con error si no se encuentra.
    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})")

    # --- Crear sububicaciones: Schublade A1..A19, B1..B19, C1..C19 ---
    # Cada sububicación se crea como hija de la ubicación Apothekerschrank
    # y recibe el tipo de ubicación "Schublade". Las ubicaciones que ya
    # existen se omiten para mantener el script idempotente.
    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()