modulo google.appengine.api.validation

Riepilogo

Strumenti di convalida per strutture di oggetti generiche.

Questa libreria viene utilizzata per definire le classi con attributi vincolati. Gli attributi vengono definiti nella classe che li contiene utilizzando gli strumenti di convalida. Anche se gli strumenti di convalida possono essere definiti da qualsiasi client di questa libreria, qui vengono forniti vari strumenti di convalida standard.

Per gli strumenti di convalida è possibile richiamare un singolo parametro che controlla il nuovo valore prima di assegnarlo all'attributo. Gli strumenti di convalida possono modificare un valore ricevuto in modo che sia appropriato per la definizione dell'attributo. Ad esempio, l'utilizzo di int come strumento di convalida trasmetterà una stringa formattata correttamente a un numero o attiverà un'eccezione se non è possibile. Tuttavia, questa azione è sconsigliata. il modo corretto per utilizzare uno strumento di convalida che garantisce l'utilizzo dello strumento di convalida del tipo corretto.

Questa libreria di convalida è destinata principalmente all'uso con il generatore di oggetti YAML. Vedi yaml_object.py.

Contenuti

google.appengine.api.validation.AsValidator(convalida)source

Aggregare vari tipi di istanze di uno strumento di convalida.

Utilizzato per consentire l'abbreviazione di tipi di convalida comuni. Converte i seguenti tipi nei seguenti strumenti di convalida.

string -> Regex type -> Type collection -> Options Validator -> It's self!

Parametri

strumento di convalida: oggetto da inserire in uno strumento di convalida.

Restituisce

Istanza di convalida che aggrega il valore specificato.

Aumenta

AttributeDefinitionError: se lo strumento di convalida non è uno dei tipi sopra descritti.

exception google.appengine.api.validation.AttributeDefinitionErrorsource

Basi: google.appengine.api.validation.Error

Si è verificato un errore nella definizione degli attributi della classe.

class google.appengine.api.validation.Ritirato(preferito, strumento di convalida, default=None)source

Basi: google.appengine.api.validation.Normalized

Un campo deprecato.

Da usare con i preferiti. Funziona solo come campo su Convalidata.

Entrambi i campi funzioneranno per l'accesso al valore. Si tratta di un errore impostare sia il campo deprecato che il corrispondente campo preferito.

Get(value, key, obj)source

GetWarnings(value, key, obj)source

ConvalidaInteramente(valore, chiave, obj)origine

exception google.appengine.api.validation.Errorsource

Basi: eccezioni.Eccezione

Classe di base per tutti gli errori del pacchetto.

class google.appengine.api.validation.Exec(default=None)source

Basi: google.appengine.api.validation.Type

Coerisce il valore per soddisfare i requisiti di Docker CMD/ENTRYPOINT.

Convalida il valore è una stringa, quindi tenta di modificare la stringa (se necessario) in modo che il comando rappresentato diventi PID 1 all'interno del container Docker. Per saperne di più, consulta la documentazione di Docker su "docker kill": https://docs.docker.com/engine/reference/commandline/kill/

Se il comando inizia già con exec o sembra essere in "form exec" (che inizia con [), non sono necessarie ulteriori azioni. In caso contrario, anteponi il comando exec in modo che diventi PID 1 all'esecuzione.

Convalida(valore, chiave)origine

La convalida avviene in base al comportamento dei genitori e costringe a iniziare con exec.

class google.appengine.api.validation.ItemDumper(stream, default_style=None, default_flow_style=None, canonical=None, indent=None,width=None, allow_unicode=None, line_break=None, encoding=None, esplicitamente_start=None, esplicite_end=Nessuno, versione=Nessuno, tag=Nessuno, block_seq_indent=nessuno_livello

Basi: google.appengine._internal.ruamel.yaml.dumper.SafeDumper

Per il dump di convalida.Elementi. Rispetta l'ordinamento delle chiavi OrdinaedDict.

rappresentanti_mapping(tag, mappatura, flusso_style=Nessuno)origine

yaml_representers = {<type 'float'>: <unbound method SafeRepresenter.represent_float>, <class 'collections.OrderedDict'>: <unbound method SafeRepresenter.represent_ordereddict>, <type 'set'>: <unbound method SafeRepresenter.represent_set>, <type 'str'>: <unbound method SafeRepresenter.represent_str>, None: <unbound method SafeRepresenter.represent_undefined>, <type 'long'>: <unbound method SafeRepresenter.represent_long>, <class 'google.appengine._internal.ruamel.yaml.compat.ordereddict'>: <unbound method SafeRepresenter.represent_ordereddict>, <type 'datetime.date'>: <unbound method SafeRepresenter.represent_date>, <type 'bool'>: <unbound method SafeRepresenter.represent_bool>, <type 'tuple'>: <unbound method SafeRepresenter.represent_list>, <type 'NoneType'>: <unbound method SafeRepresenter.represent_none>, <type 'unicode'>: <unbound method SafeRepresenter.represent_unicode>, <type 'dict'>: <unbound method SafeRepresenter.represent_dict>, <type 'int'>: <unbound method SafeRepresenter.represent_int>, <type 'datetime.datetime'>: <unbound method SafeRepresenter.represent_datetime>, <class 'google.appengine.api.validation.SortedDict'>: <unbound method ItemDumper.represent_dict>, <type 'list'>: <unbound method SafeRepresenter.represent_list>}

exception google.appengine.api.validation.MISSINGAttribute(message, cause=None)source

Basi: google.appengine.api.validation.ValidationError

Aumentato quando un attributo obbligatorio manca nell'oggetto.

class google.appengine.api.validation.Normalized(default=None)source

Basi: google.appengine.api.validation.Validator

Normalizza un campo durante la ricerca, ma serializza con il valore originale.

Funziona solo con i campi in Convalidato.

Get(value, key, obj)source

Restituisce il valore normalizzato. Le classi secondarie devono avere la precedenza.

class google.appengine.api.validation.Optional(Validator, default=None)source

Basi: google.appengine.api.validation.Validator

Definizione di attributi facoltativi.

I valori facoltativi sono attributi che possono essere impostati su Nessuno o non impostati. Tutti i valori in una classe convalidata di base sono impostati su Nessuno all'inizializzazione. La mancata assegnazione di valori non facoltativi determinerà un errore di convalida quando si chiama CheckInitialized.

ToValue(valore) source

Converti 'value' in una raccolta semplificata o un tipo di base.

Convalida(valore, chiave)origine

Facoltativamente, è necessario specificare un valore.

Gli strumenti di convalida normali non accettano il valore Nessuno. e non lo accetta per conto dello strumento di convalida contenuto.

Parametri

• value - Valore da convalidare come facoltativo.

• key – Nome del campo da convalidare.

Restituisce

Nessuno se il valore è Nessuno, in caso contrario i risultati sono contenuti di convalida.

classgoogle.appengine.api.validation.Options(*options, **kw)source

Basi: google.appengine.api.validation.Validator

Limita il campo in base a valori predeterminati.

Le opzioni vengono utilizzate per garantire che un insieme di valori enumerati sia l'unico consentito per l'assegnazione. È possibile definire alias che mappano più valori stringa su un singolo originale. Ecco un esempio di utilizzo:

class ZooAnimal(convalida.Class):

ATTRIBUTI = {

'name': str, 'kind': Opzioni ("'platypus', # No alias)

('rhinoceros', ['rhino']), # One alias ('canine', ("dog', puppy')), # Two alias )

Convalida(valore, chiave)origine

Convalida le opzioni.

Restituisce

Valore originale per l'alias fornito.

Aumenta

ValidationError: quando il valore non è uno di quelli predefiniti.

class google.appengine.api.validation.Preferred(deprecated, Validation, default=None)source

Basi: google.appengine.api.validation.Normalized

Un campo non deprecato in caso di deprecazione.

Da utilizzare con il ritiro. Funziona solo come campo su Convalidata.

Entrambi i campi funzioneranno per l'accesso al valore. Si tratta di un errore impostare sia il campo deprecato che il corrispondente campo preferito.

Get(value, key, obj)source

ConvalidaInteramente(valore, chiave, obj)origine

class google.appengine.api.validation.Range(minimum, massimi, range_type=int, default=None)source

Basi: google.appengine.api.validation.Validator

Verifica che i numeri rientrino nell'intervallo corretto.

In teoria, questa classe può essere emulata utilizzando le opzioni, ma i messaggi di errore generati da quella classe non saranno molto comprensibili. Questa classe funziona in modo analogo, ma conosce l'intervallo intero previsto.

Inoltre, questa classe di intervalli supporta floating e altri tipi che implementano l'ordinalità.

L'intervallo è inclusivo, il che significa che 3 è considerato nell'intervallo in intervallo(1,3).

Convalida(valore, chiave)origine

Verifica che il valore rientri nell'intervallo.

Convalida in base al tipo di intervallo, quindi controlla l'intervallo.

Parametri

• value - Valore da convalidare.

• key – Nome del campo da convalidare.

Risalto

• ValidationError - quando il valore non rientra nell'intervallo consentito. ValidationError durante il valore

• non è dello stesso tipo di intervallo.

class google.appengine.api.validation.Regex(regex, string_type=unicode, default=None)source

Basi: google.appengine.api.validation.Validator

Strumento di convalida delle espressioni regolari.

Lo strumento di convalida delle espressioni regolari converte sempre il valore in stringa. Ricorda che le corrispondenze devono essere esatte. Le corrispondenze parziali non vengono convalidate. Ad esempio:

class ClassDescr(Validated):

ATTRIBUTI = { 'name': Regex(r'[a-zA-Z_][a-zA-Z_0-9]*'),

'parent': Tipo(tipo), }

In alternativa, qualsiasi attributo definito come stringa viene automaticamente interpretato come di tipo Regex. È possibile specificare anche le stringhe regex Unicode. Questo approccio è leggermente meno efficiente, ma in genere non è significativo se non si analizzano grandi quantità di dati:

class ClassDescr(Validated):

ATTRIBUTI = { 'name': r'[a-zA-Z_][a-zA-Z_0-9]*',

'parent': Tipo(tipo), }

# Verrà sollevata un'eccezione ValidationError. my_class(name='AName with space', parent=AnotherClass)

Convalida(valore, chiave)origine

Fa la convalida di una stringa in relazione a un'espressione regolare.

Parametri

• value – Stringa da trovare in corrispondenza dell'espressione regolare.

• key – Nome del campo da convalidare.

Rialzi

ValidationError: quando il valore non corrisponde all'espressione regolare o quando il valore non corrisponde al tipo di stringa fornito.

class google.appengine.api.validation.RegexStr(string_type=unicode, default=None)source

Basi: google.appengine.api.validation.Validator

Verifica che una stringa possa essere compilata come regex senza errori.

Utilizza questo strumento di convalida quando il valore di un campo deve essere un'espressione regolare. Ciò significa che il valore deve essere una stringa che può essere compilata da re.compile(). L'attributo sarà quindi un oggetto re compilato.

ToValue(valore) source

Restituisce il pattern RE per questo strumento di convalida.

Convalida(valore, chiave)origine

Verifica che la stringa venga compilata come espressione regolare.

Poiché l'espressione regolare potrebbe essere stata espressa come stringa multilinea, questa funzione rimuove anche le nuove righe dal valore.

Parametri

• value: stringa da compilare come espressione regolare.

• key – Nome del campo da convalidare.

Risalto

• ValueError quando il valore non viene compilato come espressione regolare. Errore di tipo

• quando il valore non corrisponde al tipo di stringa fornito.

class google.appengine.api.validation.Ripetied(coststructor, default=None)source

Basi: google.appengine.api.validation.Validator

Strumento di convalida dei campi ripetuto.

Indica che l'attributo deve essere un valore ripetuto, ovvero una sequenza. Ciò aggiunge una convalida aggiuntiva rispetto a solo Type(list) in quanto conserva le informazioni su ciò che può essere archiviato nell'elenco tramite il suo campo costruttore.

Convalida(valore, chiave)origine

Esegui la convalida della sequenza.

Il valore deve essere un elenco e tutti gli elementi devono essere di tipo "costruttore".

Parametri

• value - Valore da convalidare.

• key – Nome del campo da convalidare.

Rialzi

ValidationError: se il valore è None, non è un elenco o uno dei suoi elementi è di tipo errato.

class google.appengine.api.validation.OrdinaedDict(chiavi, dati)source

Basi: dict

Rappresenta un dict con un particolare ordine chiave che rappresenta yaml.

ordered_items()origine

class google.appengine.api.validation.StringValidator(default=None)source

Basi: google.appengine.api.validation.Validator

Verifica che la proprietà sia una stringa di testo valida.

In Python 2: eredita dalla stringa di base In Python 3: eredita da str

Convalida(valore, chiave='???')origine

classgoogle.appengine.api.validation.TimeValueorigine

Basi: google.appengine.api.validation.Validator

Convalida i valori del tempo con le unità, ad esempio 1 ora o 3,5 giorni.

Convalida(valore, chiave)origine

Convalida un valore di tempo.

Parametri

• value - Valore da convalidare.

• key – Nome del campo da convalidare.

Rialzi

ValidationError: se il valore non è un valore temporale con il formato previsto.

class google.appengine.api.validation.Type(expected_type, convert=True, default=None)source

Basi: google.appengine.api.validation.Validator

Verifica che la proprietà sia del tipo previsto.

Se vuoi, puoi convertire il valore se non è del tipo previsto.

È possibile specificare un campo obbligatorio di un tipo specifico in forma sintetica semplicemente fornendo il tipo. Questo metodo è leggermente meno efficiente rispetto a fornire un tipo esplicito, ma non è significativo a meno che non analizzi una grande quantità di informazioni:

class Person(convalidato):

ATTRIBUTI = {‘name’: unicode,

"age": int, }

Tuttavia, nella maggior parte dei casi è preferibile utilizzare le costanti tipo:

class Person(convalidato):

ATTRIBUTES = {‘name’: TypeUnicode,

'age': TypeInt, }

GetWarnings(value, key, obj)source

Convalida(valore, chiave)origine

Verifica che il valore sia del tipo corretto.

Parametri

• value - Valore da convalidare.

• key – Nome del campo da convalidare.

Restituisce

value se il valore è del tipo corretto. Il valore è coperto dal tipo corretto se lo strumento di convalida è configurato per farlo.

Aumenta

• MISSINGAttribute: se il valore è None e il tipo previsto non è NoneType.

• ValidationError: se il valore non è del tipo corretto e lo strumento di convalida è configurato in modo da non generare conversioni o non può essere convertito.

class google.appengine.api.validation.Validated(**attributes)source

Basi: google.appengine.api.validation.ValidatedBase

Classe di base per i corsi che richiedono la convalida.

Una classe che intende utilizzare campi convalidati deve operare come sottoclasse in questa classe. Ogni classe deve definire una variabile di classe "ATTRIBUTES", che deve essere una mappa dal nome dell'attributo al suo strumento di convalida. Ad esempio:

Class Story(convalidato):

ATTRIBUTES = {‘title’: Tipo(str),

"authors": Ripetito(Tipo(str)), "isbn": Facoltativo(Tipo(str)), "pagine": Tipo(int), }

Gli attributi non elencati nella sezione ATTRIBUTE funzionano come normale e non vengono convalidati al momento dell'assegnazione.

ATTRIBUTI = Nessuno

CheckInitialized()source

Verifica che tutti i campi obbligatori siano inizializzati.

Poiché un'istanza di Validated ha inizio in uno stato non inizializzato, a volte è necessario verificare che sia stata completamente inizializzata. Il problema principale che risolve è come verificare che in un'istanza siano impostati tutti i campi obbligatori. Per impostazione predefinita, le classi di convalida non consentono Nessuno, ma tutti gli attributi vengono inizializzati su Nessuno quando viene creata un'istanza.

Aumenta

• Eccezione pertinente al tipo di convalida. Il tipo di eccezione

• è determinato dallo strumento di convalida. In genere è ValueError oppure

• Errore di tipo.

Get(chiave)source

Ottieni un singolo valore sull'istanza convalidata.

Questo metodo può essere utilizzato solo per recuperare gli attributi convalidati.

Parametri

key: il nome degli attributi.

Aumenta

ValidationError non esiste un attributo convalidato in classe.

Sorgentenon standardizzata(chiave)

Recupera un singolo valore nell'istanza convalidata, senza normalizzare.

classmethod GetConvalidaator(chiave)source

Ottieni in sicurezza la definizione dell'attributo sottostante come strumento di convalida.

Parametri

key – Nome dell'attributo da ottenere.

Restituisce

Strumento di convalida associato a un valore di chiave o attributo aggregato in uno strumento di convalida.

Aumenta

ValidationError - se questo attributo non esiste.

GetWarnings()source

Set(key, value)origine

Imposta un singolo valore sull'istanza convalidata.

Questo metodo può essere utilizzato solo per assegnare attributi convalidati.

Parametri

• key: il nome degli attributi.

• value: il valore da impostare

Rialzi

ValidationError non esiste un attributo convalidato in classe.

ToDict()origine

Converti oggetto convalidato in un dizionario.

Attraversa in modo ricorsivo tutti i suoi elementi e converte tutto in raccolte semplificate.

Restituisce

Un dict di tutti gli attributi definiti in questa classe ATTRIBUTES mappati al suo valore. Questa struttura è ricorsiva in quanto gli oggetti convalidati a cui si fa riferimento in questo oggetto e negli elenchi vengono convertiti in dict.

classgoogle.appengine.api.validation.ConvalidadBasesource

Basi: oggetto

Classe di base per tutti gli oggetti convalidati.

CheckInitialized()source

Verifica che tutti i campi obbligatori siano inizializzati.

Questa funzione viene chiamata dopo che tutti gli attributi sono stati controllati per verificare la presenza di vincoli di livello superiore, ad esempio garantendo che siano presenti tutti gli attributi obbligatori.

Le sottoclassi dovrebbero sostituire questa funzione e creare un'eccezione per eventuali errori.

classmethod GetConvalidaator(chiave)source

Puoi ottenere in sicurezza lo strumento di convalida corrispondente alla chiave specificata.

Questa funzione deve essere sostituita dalle sottoclassi

Parametri

key – L'attributo o l'elemento di cui ottenere uno strumento di convalida.

Restituisce

Strumento di convalida associato alla chiave o all'attributo.

Aumenta

ValidationError: se la chiave richiesta è illegale.

GetWarnings()source

Restituisci tutti gli avvisi che abbiamo ricevuto, insieme ai relativi campi.

Restituisce

Un elenco di tupla di (dot_field, avviso), entrambe le stringhe.

Set(key, value)origine

Imposta un singolo valore sull'istanza convalidata.

Questo metodo deve essere sostituito dalle sottoclassi.

Questo metodo può essere utilizzato solo per assegnare attributi/articoli convalidati.

Parametri

• key: il nome degli attributi.

• value: il valore da impostare

Rialzi

ValidationError - quando non esiste un attributo convalidato nella classe.

Set Multiple(attributi)source

Imposta più valori sull'istanza convalidata.

Tutti gli attributi verranno convalidati prima di essere impostati.

Parametri

attributes: un insieme di attributi/elementi da impostare.

Aumenta

ValidationError - quando non esiste un attributo convalidato nella classe.

ToDict()origine

Converti l'oggetto ValidatedBase in un dizionario.

Attraversa in modo ricorsivo tutti i suoi elementi e converte tutto in raccolte semplificate.

Le sottoclassi devono sostituire questo metodo.

Restituisce

Un dizionario che mappa tutti gli attributi a semplici raccolte o valori.

Origine ToYAML()

Stampa l'oggetto convalidato come YAML semplificato.

Restituisce

Oggetto come stringa YAML semplificata compatibile con l'analisi utilizzando il Safeload.

classgoogle.appengine.api.validation.ValidatedDict(**kwds)Fonte

Basi: google.appengine.api.validation.ValidatedBase, dict

Classe di base per i dizionari convalidati.

Puoi controllare le chiavi e i valori consentiti nel dizionario impostando KEY_VALIDATOR e VALUE_VALIDATOR come sottoclassi di Strumento di convalida (o elementi che possono essere interpretati come strumenti di convalida, consulta AsValidator).

Ad esempio, se vuoi solo chiavi con lettere maiuscole e mappate a numeri interi, puoi:

class CapitalizedIntegerDict(ValidatedDict):

KEY_VALIDATOR = Regex([A-Z].*’) VALUE_VALIDATOR = int # viene interpretato come Type(int)

Il seguente codice causerebbe un errore:

my_dict = CapitalizedIntegerDict() my_dict['lowercase'] = 5 # genera un'eccezione di convalida

Puoi nidificare liberamente gli elementi Validated e ValidatedDict in modo che:

class MasterObject(Validated):

ATTRIBUTI = {'paramdict': CapitalizedIntegerDict}

Può essere utilizzato per analizzare il seguente codice yaml:

paramdict:

ArbitraryKey: 323 un altroArbitraryKey: 9931

classmethod GetConvalidaator(chiave)source

Verifica che la chiave sia valida e restituisci un valore di convalida corrispondente.

Parametri

key: la chiave che corrisponderà allo strumento di convalida che stiamo restituisce.

GetWarnings()source

KEY_VALIDATOR = Nessuna

Set(key, value)origine

Imposta un singolo valore sull'istanza convalidata.

Questo metodo controlla che una determinata chiave e un valore siano validi e, in caso affermativo, l'elemento in questo dizionario.

Parametri

• key: il nome degli attributi.

• value: il valore da impostare

Rialzi

ValidationError - quando non esiste un attributo convalidato nella classe.

ToDict()origine

Converti l'oggetto ValidatedBase in un dizionario.

Attraversa in modo ricorsivo tutti i suoi elementi e converte tutto in raccolte semplificate.

Le sottoclassi devono sostituire questo metodo.

Restituisce

Un dizionario che mappa tutti gli attributi a semplici raccolte o valori.

VALUE_VALIDATOR = Nessuno

setdefault(key, value=None)source

Le impostazioni predefinite delle trap assicurano che tutte le coppie chiave/valore siano valide.

Consulta la documentazione per setdefault su dict per i dettagli di utilizzo.

Aumenta

• ValidationError: se la chiave specificata è illegale o

• valore non valido.

update(altro, **kwds)fonte

Aggiornamenti della trappola per garantire che tutte le coppie chiave/valore siano valide.

Per informazioni dettagliate sull'utilizzo, leggi la documentazione relativa all'aggiornamento sul comando "ctct".

Aumenta

ValidationError: se una delle chiavi specificate è illegale o i valori non sono validi.

exception google.appengine.api.validation.ValidationError(message, cause=None)source

Basi: google.appengine.api.validation.Error

Classe di base per aumentare le eccezioni durante la convalida.

class google.appengine.api.validation.Validator(default=None)source

Basi: oggetto

Classe di base dello strumento di convalida.

Sebbene qualsiasi elemento richiamabile possa essere utilizzato come strumento di convalida, questa classe comprende il caso in cui uno strumento di convalida specifico deve mantenere uno stato o una configurazione specifici.

Per implementare la sottoclasse dello strumento di convalida, sostituisci il metodo di convalida.

Questa classe può modificare il valore finale impostato sull'attributo se esiste un modo ragionevole per eseguire la conversione.

GetWarnings(value, key, obj)source

Restituisce eventuali avvisi su questo attributo.

Convalida il valore controllando con attenzione le cose che non sono problemi irreversibili.

Parametri

• value - Valore da convalidare.

• key – Nome del campo da convalidare.

• obj – L'oggetto in base al quale eseguire la convalida.

Restituisce

Un elenco di tupla (contesto, avviso) dove

• contesto è il campo (o percorso a campi tratteggiati, se un sottocampo)

• è avviso di testo della stringa

ToValue(valore) source

Converti 'value' in una raccolta semplificata o un tipo di base.

Le sottoclassi dello Strumento di convalida dovrebbero sostituire questo metodo quando la rappresentazione dump di "value" non è semplicemente <type>(value) (ad es. un'espressione regolare).

Parametri

value: un oggetto dello stesso tipo restituito da Validate().

Restituisce

Un'istanza di tipo integrato (ad es. int, str, dict e così via). Per impostazione predefinita, restituisce "value" non modificato.

Convalida(valore, chiave='???')origine

Convalida questo campo. Sostituisci per personalizzare il comportamento della classe secondaria.

Parametri

• value - Valore da convalidare.

• key – Nome del campo da convalidare.

Restituisce

Valore se il valore è valido o una rappresentazione valida.

ConvalidaInteramente(valore, chiave, obj)origine

Convalida questo campo rispetto ad altri. Eseguire l'override per personalizzare nelle classi secondarie.

Per impostazione predefinita, le chiamate vengono chiamate Validate(value, key). Poiché Validateintero

Parametri

• value - Valore da convalidare.

• key – Nome del campo da convalidare.

• obj – L'oggetto in base al quale eseguire la convalida.

Restituisce

Valore se il valore è valido o una rappresentazione valida.

tipo_previsto

alias di un oggetto