Quale eccezione da sollevare se il numero errato di argomenti è passato a ** arg?

Question

Supponiamo che in python sia presente una routine che accetta tre parametri con nome (come ** args), ma devono essere compilati due qualsiasi di questi tre. Se è compilato solo uno, è un errore. Se tutti e tre sono, è un errore. Che tipo di errore vorresti aumentare? RuntimeError, un'eccezione creata in modo specifico o altro?

Answer 1

Ricorda che puoi creare sottoclasse delle classi di eccezioni incorporate di Python (e TypeError sarebbe sicuramente la giusta classe di eccezioni built-in da sollevare qui - questo è ciò che Python solleva se il numero di argomenti non corrisponde alla firma, in normale casi senza moduli *a o **k nella firma). Mi piace avere tutti i pacchetti definire in base alle esigenze dei propri class Error(Exception), e quindi specifiche eccezioni possono moltiplicarsi ereditare a seconda dei casi, ad es .:

class WrongNumberOfArguments(thispackage.Error, TypeError): 

Poi, mi piacerebbe raise WrongNumberOfArguments quando rilevo una situazione del problema.

In questo modo, qualsiasi chiamante che è a conoscenza di questo pacchetto può catturare thispackage.Error, se è necessario gestire qualsiasi errore specifico del pacchetto, mentre altri chiamanti (presumibilmente più in alto nella catena di chiamate) chiamano ancora prendere il più generico TypeError per gestire eventuali errori come "numero errato di argomenti utilizzati in una chiamata di funzione".

Answer 2

Farei uno specifico. Puoi prenderlo e gestirlo con quell'eccezione specifica poiché è una circostanza speciale che hai creato :)

Answer 3

Se (come dici in uno dei commenti) che si tratta di un errore del programmatore, allora puoi sollevare un'eccezione di Assertion:

def two(**kwargs): 
    assert len(kwargs) == 2, "Please only provide two args" 

BTW, se hai solo tre argomenti con nome, ** kwargs sembra un modo strano per farlo. Più naturale potrebbe essere:

def two(a=None, b=None, c=None): 
    pass 

Answer 4

avrei usato un ValueError, o una sottoclasse loro: "sollevata quando incorporato in funzione o funzione riceve un argomento che ha il tipo giusto ma valore appropriato, e la situazione è non descritto da un'eccezione più precisa come IndexError. "

Passare 3 o 1 valori quando esattamente 2 sono richiesti sarebbe tecnicamente un valore inappropriato se si considerano tutti gli argomenti una singola tupla ... Almeno secondo me! :)

Answer 5

Perché non fare semplicemente ciò che fa Python?

>>> abs(1, 2, 3) 
Traceback (most recent call last): 
    File "<stdin>", line 1, in <module> 
TypeError: abs() takes exactly one argument (3 given) 

Answer 6

Si consiglia un'eccezione personalizzata. Così:

class NeedExactlyTwo(ValueError): 
    pass 

Quindi è possibile raise NeedExactlyTwo nel codice.

Assicuratevi di documentarlo nella docstring per la vostra funzione.