O que **
(estrela dupla) e *
(estrela) fazem pelos parâmetros
Eles permitem que funções sejam definidas para aceitar e que os usuários passem qualquer número de argumentos, posicional ( *
) e palavra-chave ( **
).
Definindo Funções
*args
permite qualquer número de argumentos posicionais opcionais (parâmetros), que serão atribuídos a uma tupla chamada args
.
**kwargs
permite qualquer número de argumentos opcionais de palavra-chave (parâmetros), que estarão em um ditado chamado kwargs
.
Você pode (e deve) escolher qualquer nome apropriado, mas se a intenção é que os argumentos sejam de semântica não específica args
e kwargs
sejam nomes padrão.
Expansão, passando qualquer número de argumentos
Você também pode usar *args
e **kwargs
passar parâmetros de listas (ou qualquer iterável) e dictos (ou qualquer mapeamento), respectivamente.
A função que recebe os parâmetros não precisa saber que eles estão sendo expandidos.
Por exemplo, o xrange do Python 2 não espera explicitamente *args
, mas como ele usa 3 números inteiros como argumentos:
>>> x = xrange(3) # create our *args - an iterable of 3 integers
>>> xrange(*x) # expand here
xrange(0, 2, 2)
Como outro exemplo, podemos usar a expansão dict em str.format
:
>>> foo = 'FOO'
>>> bar = 'BAR'
>>> 'this is foo, {foo} and bar, {bar}'.format(**locals())
'this is foo, FOO and bar, BAR'
Novo no Python 3: Definindo funções com argumentos apenas de palavras-chave
Você pode ter argumentos apenas de palavras-chave depois de *args
- por exemplo, aqui, kwarg2
deve ser fornecido como um argumento de palavras-chave - não em posição:
def foo(arg, kwarg=None, *args, kwarg2=None, **kwargs):
return arg, kwarg, args, kwarg2, kwargs
Uso:
>>> foo(1,2,3,4,5,kwarg2='kwarg2', bar='bar', baz='baz')
(1, 2, (3, 4, 5), 'kwarg2', {'bar': 'bar', 'baz': 'baz'})
Além disso, *
pode ser usado por si só para indicar que somente os argumentos de palavra-chave seguem, sem permitir argumentos posicionais ilimitados.
def foo(arg, kwarg=None, *, kwarg2=None, **kwargs):
return arg, kwarg, kwarg2, kwargs
Aqui, kwarg2
novamente , deve haver um argumento de palavra-chave explicitamente nomeado:
>>> foo(1,2,kwarg2='kwarg2', foo='foo', bar='bar')
(1, 2, 'kwarg2', {'foo': 'foo', 'bar': 'bar'})
E não podemos mais aceitar argumentos posicionais ilimitados porque não temos *args*
:
>>> foo(1,2,3,4,5, kwarg2='kwarg2', foo='foo', bar='bar')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: foo() takes from 1 to 2 positional arguments
but 5 positional arguments (and 1 keyword-only argument) were given
Mais uma vez, de forma mais simples, aqui precisamos kwarg
ser nomeados, não posicionalmente:
def bar(*, kwarg=None):
return kwarg
Neste exemplo, vemos que, se tentarmos passar kwarg
posicionalmente, obtemos um erro:
>>> bar('kwarg')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: bar() takes 0 positional arguments but 1 was given
Devemos passar explicitamente o kwarg
parâmetro como um argumento de palavra-chave.
>>> bar(kwarg='kwarg')
'kwarg'
Demonstrações compatíveis com Python 2
*args
(tipicamente dito "star-args") e **kwargs
(estrelas podem ser implícitas dizendo "kwargs", mas seja explícito com "starwar kwargs") são expressões comuns do Python para usar a notação *
e **
. Esses nomes de variáveis específicos não são necessários (por exemplo, você pode usar *foos
e **bars
), mas uma saída da convenção provavelmente enfurecerá seus colegas codificadores Python.
Normalmente, usamos isso quando não sabemos o que nossa função receberá ou quantos argumentos podemos estar passando e, às vezes, mesmo ao nomear cada variável separadamente, fica muito confuso e redundante (mas este é um caso em que geralmente é explícito). melhor que implícito).
Exemplo 1
A função a seguir descreve como eles podem ser usados e demonstra comportamento. Observe que o b
argumento nomeado será consumido pelo segundo argumento posicional antes:
def foo(a, b=10, *args, **kwargs):
'''
this function takes required argument a, not required keyword argument b
and any number of unknown positional arguments and keyword arguments after
'''
print('a is a required argument, and its value is {0}'.format(a))
print('b not required, its default value is 10, actual value: {0}'.format(b))
# we can inspect the unknown arguments we were passed:
# - args:
print('args is of type {0} and length {1}'.format(type(args), len(args)))
for arg in args:
print('unknown arg: {0}'.format(arg))
# - kwargs:
print('kwargs is of type {0} and length {1}'.format(type(kwargs),
len(kwargs)))
for kw, arg in kwargs.items():
print('unknown kwarg - kw: {0}, arg: {1}'.format(kw, arg))
# But we don't have to know anything about them
# to pass them to other functions.
print('Args or kwargs can be passed without knowing what they are.')
# max can take two or more positional args: max(a, b, c...)
print('e.g. max(a, b, *args) \n{0}'.format(
max(a, b, *args)))
kweg = 'dict({0})'.format( # named args same as unknown kwargs
', '.join('{k}={v}'.format(k=k, v=v)
for k, v in sorted(kwargs.items())))
print('e.g. dict(**kwargs) (same as {kweg}) returns: \n{0}'.format(
dict(**kwargs), kweg=kweg))
Podemos verificar a ajuda online da assinatura da função, com help(foo)
, o que nos diz
foo(a, b=10, *args, **kwargs)
Vamos chamar essa função com foo(1, 2, 3, 4, e=5, f=6, g=7)
que imprime:
a is a required argument, and its value is 1
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 2
unknown arg: 3
unknown arg: 4
kwargs is of type <type 'dict'> and length 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: g, arg: 7
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args)
4
e.g. dict(**kwargs) (same as dict(e=5, f=6, g=7)) returns:
{'e': 5, 'g': 7, 'f': 6}
Exemplo 2
Também podemos chamá-lo usando outra função, na qual apenas fornecemos a
:
def bar(a):
b, c, d, e, f = 2, 3, 4, 5, 6
# dumping every local variable into foo as a keyword argument
# by expanding the locals dict:
foo(**locals())
bar(100)
impressões:
a is a required argument, and its value is 100
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 0
kwargs is of type <type 'dict'> and length 4
unknown kwarg - kw: c, arg: 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: d, arg: 4
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args)
100
e.g. dict(**kwargs) (same as dict(c=3, d=4, e=5, f=6)) returns:
{'c': 3, 'e': 5, 'd': 4, 'f': 6}
Exemplo 3: uso prático em decoradores
OK, então talvez ainda não estejamos vendo o utilitário. Imagine que você tenha várias funções com código redundante antes e / ou depois do código de diferenciação. As seguintes funções nomeadas são apenas pseudocódigo para fins ilustrativos.
def foo(a, b, c, d=0, e=100):
# imagine this is much more code than a simple function call
preprocess()
differentiating_process_foo(a,b,c,d,e)
# imagine this is much more code than a simple function call
postprocess()
def bar(a, b, c=None, d=0, e=100, f=None):
preprocess()
differentiating_process_bar(a,b,c,d,e,f)
postprocess()
def baz(a, b, c, d, e, f):
... and so on
Podemos ser capazes de lidar com isso de maneira diferente, mas certamente podemos extrair a redundância com um decorador; portanto, nosso exemplo abaixo demonstra como *args
e **kwargs
pode ser muito útil:
def decorator(function):
'''function to wrap other functions with a pre- and postprocess'''
@functools.wraps(function) # applies module, name, and docstring to wrapper
def wrapper(*args, **kwargs):
# again, imagine this is complicated, but we only write it once!
preprocess()
function(*args, **kwargs)
postprocess()
return wrapper
E agora todas as funções agrupadas podem ser escritas de maneira muito mais sucinta, como consideramos a redundância:
@decorator
def foo(a, b, c, d=0, e=100):
differentiating_process_foo(a,b,c,d,e)
@decorator
def bar(a, b, c=None, d=0, e=100, f=None):
differentiating_process_bar(a,b,c,d,e,f)
@decorator
def baz(a, b, c=None, d=0, e=100, f=None, g=None):
differentiating_process_baz(a,b,c,d,e,f, g)
@decorator
def quux(a, b, c=None, d=0, e=100, f=None, g=None, h=None):
differentiating_process_quux(a,b,c,d,e,f,g,h)
E, considerando o nosso código, o que *args
e o **kwargs
que nos permite fazer, reduzimos as linhas de código, melhoramos a legibilidade e a capacidade de manutenção e temos únicos locais canônicos para a lógica do nosso programa. Se precisarmos alterar qualquer parte dessa estrutura, teremos um lugar para fazer cada alteração.