InvenTree: criar locais de estoque em lote via script Python API

#!/usr/bin/env python3
"""Criar sublocais Schublade sob um local Apothekerschrank no InvenTree.

Este script se conecta a uma instância do InvenTree via API REST e cria
um conjunto de sublocais de gaveta ("Schublade") sob um local pai
chamado "Apothekerschrank". Para cada uma das três fileiras A, B e C,
cria gavetas numeradas de 1 a 19, totalizando 57 sublocais.
Cada sublocal recebe o tipo de local de estoque "Schublade".

O script é idempotente: se um sublocal já existir sob o pai,
ele é ignorado em vez de duplicado.

A configuração é lida de ``config.yaml`` no mesmo diretório:

.. 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

# Caminho para o arquivo de configuração YAML, esperado ao lado deste script.
CONFIG_PATH = Path(__file__).parent / "config.yaml"


def load_config():
    """Carregar configurações de conexão do InvenTree de ``config.yaml``.

    Retorna um dict com as chaves ``server`` e ``token``.
    """
    with open(CONFIG_PATH, "r") as f:
        return yaml.safe_load(f)["inventree"]


class InvenTreeAPI:
    """Cliente mínimo de API REST para o InvenTree.

    Envolve :mod:`requests` com autenticação baseada em token e métodos
    de conveniência para chamadas GET e POST à API do InvenTree.
    """

    def __init__(self, server, token):
        """Inicializar o cliente da API.

        :param server: URL base da instância do InvenTree, ex.:
            ``https://inventree.example.com``.
        :param token: Token de autenticação da API (gere um na
            interface web do InvenTree em *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):
        """Executar uma requisição GET e retornar a resposta JSON analisada."""
        r = self.session.get(f"{self.server}{path}", params=params)
        r.raise_for_status()
        return r.json()

    def post(self, path, data):
        """Executar uma requisição POST com corpo JSON e retornar a resposta analisada."""
        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):
    """Encontrar um tipo de local de estoque por nome.

    Itera por todos os tipos de local via chamadas paginadas da API.
    Retorna a chave primária (``pk``) se encontrado, caso contrário ``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):
    """Encontrar um local de estoque por nome entre todos os locais.

    Itera por todos os locais de estoque via chamadas paginadas da API.
    Retorna a chave primária (``pk``) se encontrado, caso contrário ``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):
    """Encontrar um local de estoque filho por nome sob um pai informado.

    Consulta a API por todos os locais cujo ``parent`` corresponde a
    ``parent_pk`` e retorna o ``pk`` da primeira correspondência, ou ``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():
    """Ponto de entrada principal: encontrar local pai, garantir tipo de local, criar sublocais."""
    config = load_config()
    api = InvenTreeAPI(config["server"], config["token"])

    # --- Encontrar ou criar o tipo de local de estoque "Schublade" ---
    # O InvenTree suporta tipos de local definidos pelo usuário que podem
    # ser atribuídos a locais de estoque individuais. Reutilizamos um
    # tipo existente, se 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})")

    # --- Encontrar o local pai "Apothekerschrank" ---
    # Este local já deve existir no InvenTree. O script encerrará com
    # erro se não conseguir encontrá-lo.
    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})")

    # --- Criar sublocais: Schublade A1..A19, B1..B19, C1..C19 ---
    # Cada sublocal é criado como filho do local Apothekerschrank e
    # recebe o tipo de local "Schublade". Locais que já existem são
    # ignorados para manter o 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()