Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document shared caching between script runs

Chiusa Adatta ai principianti
  • Qualcosa non va?
#40 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
Mezza giornata
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
django, python
Ambito
documentation

Direzione di ricerca

Inizia leggendo docs/user-guide/authoring.md e le indicazioni sull'API della cache di Django. Aggiungi una ricetta collegata che tratti i backend condivisi tra deployment, la scadenza, i cache miss, il namespace delle chiavi, l'invalidazione, i limiti di concorrenza, gli avvisi di sicurezza e la distinzione rispetto alla cache delle fonti verificate di NetBox; il lavoro è completato quando la guida di authoring contiene un link a una documentazione completa.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

app: scripts status: accepted type: documentation
Change Type

Addition

Proposed Changes

Add a recipe linked from docs/user-guide/authoring.md for caching an expensive external lookup with Django's cache API and a deployment-configured backend. Include explicit expiry and a safe cache-miss fallback.

Explain when the backend shares values across workers. Namespace keys by Project and purpose, adding revision or user scope where needed. Cover invalidation and concurrent misses without promising backend-independent locking, atomic operations, or LRU eviction.

Warn against caching secrets, sharing permission-filtered results under a common key, or clearing NetBox's entire cache. Distinguish this application-data cache from the plugin's verified source cache.

The aim is guidance for authors, not a new cache service or persistence API.

Related request: netbox-community/netbox#21007.

Lingua principale
Python
Stelle
8
Fork
0
Merge medio
11h 35m
PR unite (30g)
20

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di netbox-community/netbox-scripts

Tutte le issue di netbox-community/netbox-scripts

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.