3.20.3 Funzioni disponibili

warn( message[, category[, stacklevel]])

Emette un avvertimento, o può ignorarlo, oppure sollevare un'eccezione. L'argomento category, se indicato, deve essere una classe di una categoria di avvertimenti (vedete sopra); il suo comportamento predefinito consiste nel sollevare un'eccezione UserWarning. Alternativamente, message può essere un'istanza di Warning, nel cui caso category verrà ignorata, e verrà usato message.__class__. In questo caso il messaggio di testo sarà str(message). Questa funzione solleva un'eccezione se il particolare avvertimento emesso viene modificato in un errore dal filtro degli avvertimenti visto sopra. L'argomento stacklevel può venire usato per interfacciare funzioni scritte in Python come la seguente:

def deprecation(message):
    warnings.warn(message, DeprecationWarning, stacklevel=2)

Questo fa sì che l'avvertimento si riferisca al chiamante di deprecation(), piuttosto che all'originale deprecation() stesso (poiché il successivo potrebbe fallire lo scopo del messaggio di avvertimento).

warn_explicit( messagge, category, filename, lineno[, module[, registry]]): Questa è un'interfaccia di basso livello per la funzionalità di warn(), a cui vengono passati esplicitamente il messaggio, la categoria, il filename, il numero di riga ed opzionalmente il nome del modulo e il registry (che dovrebbe essere un dizionario __warningregistry__ del modulo). Il nome predefinito del modulo corrisponde a quello del filename, a cui viene rimossa l'estensione .py; se non viene passato nessun registry, l'avvertimento non viene mai soppresso. message deve essere una stringa e category una classe derivata di Warning, oppure message può essere un'istanza Warning, nel qual caso category verrà ignorata.

showwarning( message, category, filename, lineno[, file]): Scrive un avvertimento in un file. L'implementazione predefinita chiama formatwarning(message, category, filename, lineno) e scrive la stringa risultante in file, il cui predefinito è sys.stderr. Potete rimpiazzare questa funzione con una implementazione alternativa assegnandola a warnings.showwarning.

formatwarning( message, category, filename, lineno): Compone un avvertimento nel modo standard. Restituisce una stringa che può contenere al suo interno i caratteri di fine riga, e terminare con un carattere di fine riga.

filterwarnings( action[, message[, category[, module[, lineno[, append]]]]]): Inserisce un elemento nella lista dei filtri degli avvertimenti. L'elemento viene inserito all'inizio della lista, in modo predefinito; se append è vero, viene inserito alla fine. Questa funzione verifica i tipi degli argomenti, compila il messaggio e le espressioni regolari del modulo, e li inserisce in una tupla all'inizio del filtro degli avvertimenti. Elementi inseriti successivamente sovrascrivono gli elementi inseriti per primi, se entrambi corrispondono ad un particolare avvertimento. Gli argomenti omessi vengono impostati ad un valore predefinito che soddisfi ogni corrispondenza.

resetwarnings( ): Azzerano il filtro degli avvertimenti. Questo annulla gli effetti di tutte le precedenti chiamate a filterwarnings(), includendo anche quelli delle opzioni sulla riga di comando indicati con -W.

Vedete Circa questo documento... per informazioni su modifiche e suggerimenti.