a90b7443e4
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
3.5 KiB
3.5 KiB
name, kind, lang, domain, version, purity, signature, description, tags, uses_functions, uses_types, returns, returns_optional, error_type, imports, params, output, tested, tests, test_file_path, file_path
| name | kind | lang | domain | version | purity | signature | description | tags | uses_functions | uses_types | returns | returns_optional | error_type | imports | params | output | tested | tests | test_file_path | file_path | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| register_obsidian_vault | function | py | obsidian | 1.0.0 | impure | def register_obsidian_vault(vault_path: str, open: bool = False, config_path: str = '') -> dict | Registra un vault en la app de escritorio Obsidian anadiendo su entrada a la clave 'vaults' de ~/.config/obsidian/obsidian.json. Opera sobre la config de la app, NO sobre el filesystem del vault. Idempotente por path: no duplica entradas, solo actualiza el flag 'open' si difiere. Genera id hex de 16 chars (secrets.token_hex(8)) y ts en epoch ms. Hace backup .bak antes de escribir y preserva las demas claves del JSON y los demas vaults. |
|
false | error_go_core |
|
|
dict con id (hex 16), path (abs), registered (bool, True si entrada nueva), already (bool, True si ya existia), open (bool final), config_path y backup_path (ruta del .bak o '' si no habia archivo previo) | true |
|
python/functions/obsidian/register_obsidian_vault_test.py | python/functions/obsidian/register_obsidian_vault.py |
Ejemplo
import sys, os
sys.path.insert(0, os.path.join("python", "functions"))
from obsidian import register_obsidian_vault
res = register_obsidian_vault(
vault_path="/home/enmanuel/vaults/osint",
open=True,
config_path="", # usa ~/.config/obsidian/obsidian.json
)
print(res["id"], res["registered"], res["already"])
# 3f9a1c0b7e2d4a86 True False (primera vez)
# 3f9a1c0b7e2d4a86 False True (segunda vez, ya registrado)
Cuando usarla
Cuando quieras que la app de escritorio Obsidian "conozca" un vault y lo muestre en su selector de vaults (la pantalla de bienvenida / Open another vault). Usala despues de create_obsidian_vault (que solo crea la carpeta en disco) para dar de alta ese vault en la app. Es el paso previo natural a open_obsidian_vault.
Gotchas
- Escribe la config de la app (I/O impuro) en
~/.config/obsidian/obsidian.jsony crea un backup.bakantes de sobreescribir. Si la entrada ya existe y nada cambia, NO reescribe ni genera backup. - NO crea la carpeta del vault: solo registra la entrada. Si la ruta no existe en disco, Obsidian la mostrara pero no podra abrirla. Usa
create_obsidian_vaultpara crear la carpeta. - Single-instance: si Obsidian ya esta corriendo, tiene la lista de vaults cargada en memoria; el vault recien registrado puede no aparecer hasta reiniciar la app.
- Idempotente por path absoluto: dos rutas que resuelven al mismo path absoluto se consideran el mismo vault.
- Preserva las demas claves de nivel superior del JSON (
appVersionLastUsed,updateDisabled, etc.) y los demas vaults; solo toca la entrada de este vault.