La classe Key

Nota: gli sviluppatori che creano nuove applicazioni sono vivamente invitati a utilizzare la libreria client NDB, che offre diversi vantaggi rispetto a questa libreria client, ad esempio la memorizzazione nella cache automatica delle entità tramite l'API Memcache. Se al momento utilizzi la libreria client DB precedente, leggi la guida alla migrazione da DB a NDB

Un'istanza della classe Key rappresenta una chiave univoca per un'entità Datastore.

Key è fornito dal modulo google.appengine.ext.db.

Introduzione

Ogni istanza del modello ha una chiave di identificazione, che include il tipo di entità dell'istanza insieme a un identificatore univoco. L'identificatore può essere una stringa nome chiave, assegnata esplicitamente dall'applicazione al momento della creazione dell'istanza, o un ID numerico intero, assegnato automaticamente da App Engine quando l'istanza viene scritta (put) in Datastore. L'istanza del modello key() restituisce l'oggetto Key per l'istanza. Se all'istanza non è ancora stata assegnata una chiave, key() genera un NotSavedError.

Un'applicazione può recuperare un'istanza di modello per una determinata chiave utilizzando la funzione get().

Le istanze chiave possono essere valori per le proprietà di entità Datastore, inclusi i membri di Espandio e ListProperty. Il modello ReferenceProperty fornisce funzionalità per i valori della proprietà Key, come il dereferenziamento automatico.

Costruttore

class Key(encoded=None)

Una chiave univoca per un oggetto Datastore.

Una chiave può essere convertita in una stringa passando l'oggetto Key a str(). La stringa è "urlsafe": utilizza solo caratteri validi per l'uso negli URL. La rappresentazione stringa della chiave può essere convertita nuovamente in un oggetto Key passandola al costruttore Key (l'argomento codificato).

Nota: la rappresentazione di una chiave sotto forma di stringa sembra enigmatica, ma non è criptata. Possono essere riconvertiti in dati chiave non elaborati, sia di tipo che identificativo dell'utente. Se non vuoi esporre questi dati agli utenti (e consentire loro di indovinare facilmente le chiavi di altre entità), cripta queste stringhe o utilizza qualcos'altro.

codificato

La forma str di un'istanza Key da convertire nuovamente in una Key.

Metodi della classe

La classe Key fornisce il seguente metodo di classe:

Key.from_path(*path, parent=None, namespace=None)

Consente di creare un nuovo oggetto Key da un percorso (facoltativo) di un antenato (in un oggetto Key esistente) e da uno o più nuovi componenti del percorso. Ogni componente del percorso è costituito da un nome Tipo (kind) e da un identificatore (id_or_name), che può essere un numero o una stringa di caratteri.

Un percorso rappresenta la gerarchia delle relazioni padre-figlio per un'entità. Ogni entità nel percorso è rappresentata dal tipo di entità e dal relativo ID numerico o dal nome della chiave. Il percorso completo rappresenta l'entità visualizzata per ultima nel percorso, con i suoi antenati (genitori) come entità precedenti.

Ad esempio, la chiamata seguente crea una chiave per un'entità di tipo Address con ID numerico 9876, sotto la chiave principale User/Boris:

k = Key.from_path('User', 'Boris', 'Address', 9876)

Un modo alternativo per creare la stessa chiave è il seguente:

p1 = Key.from_path('User', 'Boris')
k = Key.from_path('Address', 9876, parent=p1)

Per ulteriori informazioni sui percorsi, consulta la pagina Entità, proprietà e chiavi.

Argomenti

path

Un elenco di uno o più componenti del percorso dell'antenato, in cui ogni componente è costituito da un tipo e da un identificatore:

• kind: il tipo di entità, rappresentato come stringa o stringa Unicode.
• identifier: il valore id, specificato come stringa o long. Non può essere il numero 0.

namespace=None

Lo spazio dei nomi da impostare solo per questa chiave. Se fornisci uno spazio dei nomi qui, questo sostituisce lo spazio dei nomi corrente impostato in namespace_manager. Se None, l'API utilizza lo spazio dei nomi corrente di namespace_manager.get_namespace.

parent=None

Chiave principale facoltativa. Se non viene specificato, il valore predefinito è None.

Metodi istanza

Le istanze chiave hanno i seguenti metodi:

app()

Restituisce il nome dell'applicazione in cui è stata archiviata l'entità dati.

has_id_or_name()

Restituisce True se l'entità ha un nome o un ID numerico.

id()

Restituisce l'ID numerico dell'entità di dati come numero intero o None se l'entità non ha un ID numerico.

id_or_name()

Restituisce il nome o l'ID numerico dell'entità dati, a seconda di quale presenta, oppure None se l'entità non ha né un nome né un ID numerico.

kind()

Restituisce il tipo di entità dati, come stringa.

nome()

Restituisce il nome dell'entità dati o None se l'entità non ha un nome.

spazio dei nomi()

Restituisce lo spazio dei nomi dell'entità dati. Se l'entità non ha uno spazio dei nomi corrente, questo metodo restituisce lo spazio dei nomi corrente impostato in namespace_manager.

parent()

Restituisce la chiave dell'entità padre dell'entità dati o None se l'entità non ha un elemento padre.