8. Instruções compostas

Instruções compostas contém (grupos de) outras instruções; Elas afetam ou controlam a execução dessas outras instruções de alguma maneira. Em geral, instruções compostas abrangem múltiplas linhas, no entanto em algumas manifestações simples uma instrução composta inteira pode estar contida em uma linha.

As instruções if, while e for implementam construções tradicionais de controle do fluxo de execução. try especifica tratadores de exceção e/ou código de limpeza para uma instrução ou grupo de instruções, enquanto a palavra reservada with permite a execução de código de inicialização e finalização em volta de um bloco de código. Definições de função e classe também são sintaticamente instruções compostas.

Uma instrução composta consiste em uma ou mais “cláusulas”. Uma cláusula consiste em um cabeçalho e um “conjunto”. Os cabeçalhos das cláusulas de uma instrução composta específica estão todos no mesmo nível de indentação. Cada cabeçalho de cláusula começa com uma palavra reservada de identificação exclusiva e termina com dois pontos. Um conjunto é um grupo de instruções controladas por uma cláusula. Um conjunto pode ser uma ou mais instruções simples separadas por ponto e vírgula na mesma linha do cabeçalho, após os dois pontos do cabeçalho, ou pode ser uma ou mais instruções indentadas nas linhas subsequentes. Somente a última forma de conjunto pode conter instruções compostas aninhadas; o seguinte é ilegal, principalmente porque não ficaria claro a qual cláusula if a seguinte cláusula else pertenceria:

if test1: if test2: print(x)

Observe também que o ponto e vírgula é mais vinculado que os dois pontos neste contexto, de modo que no exemplo a seguir, todas ou nenhuma das chamadas print() são executadas:

if x < y < z: print(x); print(y); print(z)

Resumindo:

compound_stmt ::=  if_stmt
                   | while_stmt
                   | for_stmt
                   | try_stmt
                   | with_stmt
                   | match_stmt
                   | funcdef
                   | classdef
                   | async_with_stmt
                   | async_for_stmt
                   | async_funcdef
suite         ::=  stmt_list NEWLINE | NEWLINE INDENT statement+ DEDENT
statement     ::=  stmt_list NEWLINE | compound_stmt
stmt_list     ::=  simple_stmt (";" simple_stmt)* [";"]

Note que instruções sempre terminam em uma NEWLINE possivelmente seguida por uma DEDENT. Note também que cláusulas opcionais de continuação sempre começam com uma palavra reservada que não pode iniciar uma instrução, desta forma não há ambiguidades (o problema do “else pendurado” é resolvido em Python obrigando que instruções if aninhadas tenham indentação)

A formatação das regras de gramática nas próximas seções põe cada cláusula em uma linha separada para as tornar mais claras.

8.1. A instrução if

A instrução if é usada para execução condicional:

if_stmt ::=  "if" assignment_expression ":" suite
             ("elif" assignment_expression ":" suite)*
             ["else" ":" suite]

Ele seleciona exatamente um dos conjuntos avaliando as expressões uma por uma até que uma seja considerada verdadeira (veja a seção Operações booleanas para a definição de verdadeiro e falso); então esse conjunto é executado (e nenhuma outra parte da instrução if é executada ou avaliada). Se todas as expressões forem falsas, o conjunto da cláusula else, se presente, é executado.

8.2. A instrução while

A instrução while é usada para execução repetida desde que uma expressão seja verdadeira:

while_stmt ::=  "while" assignment_expression ":" suite
                ["else" ":" suite]

Isto testa repetidamente a expressão e, se for verdadeira, executa o primeiro conjunto; se a expressão for falsa (o que pode ser a primeira vez que ela é testada) o conjunto da cláusula else, se presente, é executado e o laço termina.

Uma instrução break executada no primeiro conjunto termina o loop sem executar o conjunto da cláusula else. Uma instrução continue executada no primeiro conjunto ignora o resto do conjunto e volta a testar a expressão.

8.3. A instrução for

A instrução for é usada para iterar sobre os elementos de uma sequência (como uma string, tupla ou lista) ou outro objeto iterável:

for_stmt ::=  "for" target_list "in" expression_list ":" suite
              ["else" ":" suite]

The expression list is evaluated once; it should yield an iterable object. An iterator is created for the result of the expression_list. The suite is then executed once for each item provided by the iterator, in the order returned by the iterator. Each item in turn is assigned to the target list using the standard rules for assignments (see Instruções de atribuição), and then the suite is executed. When the items are exhausted (which is immediately when the sequence is empty or an iterator raises a StopIteration exception), the suite in the else clause, if present, is executed, and the loop terminates.

Uma instrução break executada no primeiro conjunto termina o loop sem executar o conjunto da cláusula else. Uma instrução continue executada no primeiro conjunto pula o resto do conjunto e continua com o próximo item, ou com a cláusula else se não houver próximo item.

O laço for faz atribuições às variáveis na lista de destino. Isso substitui todas as atribuições anteriores a essas variáveis, incluindo aquelas feitas no conjunto do laço for:

for i in range(10):
    print(i)
    i = 5             # this will not affect the for-loop
                      # because i will be overwritten with the next
                      # index in the range

Os nomes na lista de destinos não são excluídos quando o laço termina, mas se a sequência estiver vazia, eles não serão atribuídos pelo laço. Dica: o tipo embutido range() representa sequências aritméticas imutáveis de inteiros. Por exemplo, iterar range(3) sucessivamente produz 0, 1 e depois 2.

8.4. A instrução try

The try statement specifies exception handlers and/or cleanup code for a group of statements:

try_stmt  ::=  try1_stmt | try2_stmt
try1_stmt ::=  "try" ":" suite
               ("except" [expression ["as" identifier]] ":" suite)+
               ["else" ":" suite]
               ["finally" ":" suite]
try2_stmt ::=  "try" ":" suite
               "finally" ":" suite

The except clause(s) specify one or more exception handlers. When no exception occurs in the try clause, no exception handler is executed. When an exception occurs in the try suite, a search for an exception handler is started. This search inspects the except clauses in turn until one is found that matches the exception. An expression-less except clause, if present, must be last; it matches any exception. For an except clause with an expression, that expression is evaluated, and the clause matches the exception if the resulting object is “compatible” with the exception. An object is compatible with an exception if the object is the class or a non-virtual base class of the exception object, or a tuple containing an item that is the class or a non-virtual base class of the exception object.

If no except clause matches the exception, the search for an exception handler continues in the surrounding code and on the invocation stack. 1

If the evaluation of an expression in the header of an except clause raises an exception, the original search for a handler is canceled and a search starts for the new exception in the surrounding code and on the call stack (it is treated as if the entire try statement raised the exception).

When a matching except clause is found, the exception is assigned to the target specified after the as keyword in that except clause, if present, and the except clause’s suite is executed. All except clauses must have an executable block. When the end of this block is reached, execution continues normally after the entire try statement. (This means that if two nested handlers exist for the same exception, and the exception occurs in the try clause of the inner handler, the outer handler will not handle the exception.)

When an exception has been assigned using as target, it is cleared at the end of the except clause. This is as if

except E as N:
    foo

fosse traduzido para

except E as N:
    try:
        foo
    finally:
        del N

This means the exception must be assigned to a different name to be able to refer to it after the except clause. Exceptions are cleared because with the traceback attached to them, they form a reference cycle with the stack frame, keeping all locals in that frame alive until the next garbage collection occurs.

Before an except clause’s suite is executed, details about the exception are stored in the sys module and can be accessed via sys.exc_info(). sys.exc_info() returns a 3-tuple consisting of the exception class, the exception instance and a traceback object (see section A hierarquia de tipos padrão) identifying the point in the program where the exception occurred. The details about the exception accessed via sys.exc_info() are restored to their previous values when leaving an exception handler:

>>>

>>> print(sys.exc_info())
(None, None, None)
>>> try:
...     raise TypeError
... except:
...     print(sys.exc_info())
...     try:
...          raise ValueError
...     except:
...         print(sys.exc_info())
...     print(sys.exc_info())
...
(<class 'TypeError'>, TypeError(), <traceback object at 0x10efad080>)
(<class 'ValueError'>, ValueError(), <traceback object at 0x10efad040>)
(<class 'TypeError'>, TypeError(), <traceback object at 0x10efad080>)
>>> print(sys.exc_info())
(None, None, None)

A cláusula opcional else é executada se o fluxo de controle deixar o conjunto try, nenhuma exceção foi levantada e nenhuma instrução return, continue ou break foi executada. Exceções na cláusula else não são manipuladas pelas cláusulas except precedentes.

If finally is present, it specifies a ‘cleanup’ handler. The try clause is executed, including any except and else clauses. If an exception occurs in any of the clauses and is not handled, the exception is temporarily saved. The finally clause is executed. If there is a saved exception it is re-raised at the end of the finally clause. If the finally clause raises another exception, the saved exception is set as the context of the new exception. If the finally clause executes a return, break or continue statement, the saved exception is discarded:

>>>

>>> def f():
...     try:
...         1/0
...     finally:
...         return 42
...
>>> f()
42

The exception information is not available to the program during execution of the finally clause.

When a return, break or continue statement is executed in the try suite of a try…finally statement, the finally clause is also executed ‘on the way out.’

The return value of a function is determined by the last return statement executed. Since the finally clause always executes, a return statement executed in the finally clause will always be the last one executed:

>>>

>>> def foo():
...     try:
...         return 'try'
...     finally:
...         return 'finally'
...
>>> foo()
'finally'

Informações adicionais sobre exceções podem ser encontradas na seção Exceções, e informações sobre como usar a instrução raise para gerar exceções podem ser encontradas na seção A instrução raise.

Alterado na versão 3.8: Prior to Python 3.8, a continue statement was illegal in the finally clause due to a problem with the implementation.

8.5. A instrução with

A instrução with é usada para envolver em um invólucro a execução de um bloco com métodos definidos por um gerenciador de contexto (veja a seção Gerenciadores de contexto da instrução with). Isso permite que padrões comuns de uso de try…except…finally sejam encapsulados para reutilização conveniente.

with_stmt          ::=  "with" ( "(" with_stmt_contents ","? ")" | with_stmt_contents ) ":" suite
with_stmt_contents ::=  with_item ("," with_item)*
with_item          ::=  expression ["as" target]

A execução da instrução with com um “item” ocorre da seguinte maneira:

1. A expressão de contexto (a expressão fornecida em with_item) é avaliada para obter um gerenciador de contexto.

2. The context manager’s __enter__() is loaded for later use.

3. The context manager’s __exit__() is loaded for later use.

4. The context manager’s __enter__() method is invoked.

5. If a target was included in the with statement, the return value from __enter__() is assigned to it.

   Nota

   The with statement guarantees that if the __enter__() method returns without an error, then __exit__() will always be called. Thus, if an error occurs during the assignment to the target list, it will be treated the same as an error occurring within the suite would be. See step 7 below.

6. O conjunto é executado.

7. The context manager’s __exit__() method is invoked. If an exception caused the suite to be exited, its type, value, and traceback are passed as arguments to __exit__(). Otherwise, three None arguments are supplied.

   If the suite was exited due to an exception, and the return value from the __exit__() method was false, the exception is reraised. If the return value was true, the exception is suppressed, and execution continues with the statement following the with statement.

   If the suite was exited for any reason other than an exception, the return value from __exit__() is ignored, and execution proceeds at the normal location for the kind of exit that was taken.

O seguinte código:

with EXPRESSION as TARGET:
    SUITE

é semanticamente equivalente a:

manager = (EXPRESSION)
enter = type(manager).__enter__
exit = type(manager).__exit__
value = enter(manager)
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not exit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        exit(manager, None, None, None)

Com mais de um item, os gerenciadores de contexto são processados como se várias instruções with estivessem aninhadas:

with A() as a, B() as b:
    SUITE

é semanticamente equivalente a:

with A() as a:
    with B() as b:
        SUITE

Você também pode escrever gerenciadores de contexto multi-item em várias linhas se os itens estiverem entre parênteses. Por exemplo:

with (
    A() as a,
    B() as b,
):
    SUITE

Alterado na versão 3.1: Suporte para múltiplas expressões de contexto.

Alterado na versão 3.10: Suporte para usar parênteses de agrupamento para dividir a instrução em várias linhas.

Ver também

PEP 343 - A instrução “with”

A especificação, o histórico e os exemplos para a instrução Python with.

8.6. A instrução match

Novo na versão 3.10.

A instrução match é usada para correspondência de padrões. Sintaxe:

match_stmt   ::=  'match' subject_expr ":" NEWLINE INDENT case_block+ DEDENT
subject_expr ::=  star_named_expression "," star_named_expressions?
                  | named_expression
case_block   ::=  'case' patterns [guard] ":" block

Nota

Esta seção usa aspas simples para denotar palavras reservadas contextuais.

A correspondência de padrões aceita um padrão como entrada (seguindo case) e um valor de sujeito (seguindo match). O padrão (que pode conter subpadrões) é correspondido ao valor de assunto. Os resultados são:

• Um sucesso ou falha de correspondência (também chamado de sucesso ou falha de padrão).

• Possível vinculação de valores correspondentes a um nome. Os pré-requisitos para isso são discutidos mais adiante.

As palavras reservadas match e case são palavras reservadas contextuais.

Ver também

• PEP 634 – Structural Pattern Matching: Specification

• PEP 636 – Correspondência de padrões estruturais: Tutorial

8.6.1. Visão Geral

Aqui está uma visão geral do fluxo lógico de uma instrução match:

1. A expressão de sujeito subject_expr é avaliada e um valor de sujeito resultante é obtido. Se a expressão de sujeito contiver uma vírgula, uma tupla é construída usando as regras padrão.

2. Cada padrão em um case_block é tentado para corresponder ao valor de sujeito. As regras específicas para sucesso ou falha são descritas abaixo. A tentativa de correspondência também pode vincular alguns ou todos os nomes autônomos dentro do padrão. As regras precisas de vinculação de padrão variam por tipo de padrão e são especificadas abaixo. As vinculações de nome feitas durante uma correspondência de padrão bem-sucedida sobrevivem ao bloco executado e podem ser usadas após a instrução match.

   Nota

   Durante correspondências de padrões com falha, alguns subpadrões podem ter sucesso. Não confie em vinculações sendo feitas para uma correspondência com falha. Por outro lado, não confie em variáveis permanecendo inalteradas após uma correspondência com falha. O comportamento exato depende da implementação e pode variar. Esta é uma decisão intencional feita para permitir que diferentes implementações adicionem otimizações.

3. Se o padrão for bem-sucedido, o guard correspondente (se presente) é avaliado. Neste caso, todas as vinculações de nome são garantidas como tendo acontecido.

   • Se o guard for avaliado como verdadeiro ou estiver ausente, o block dentro de case_block será executado.

   • Caso contrário, o próximo case_block será tentado conforme descrito acima.

   • Se não houver mais blocos de caso, a instrução match será concluída.

Nota

Os usuários geralmente nunca devem confiar em um padrão sendo avaliado. Dependendo da implementação, o interpretador pode armazenar valores em cache ou usar outras otimizações que pulam avaliações repetidas.

Um exemplo de instrução match:

>>>

>>> flag = False
>>> match (100, 200):
...    case (100, 300):  # Mismatch: 200 != 300
...        print('Case 1')
...    case (100, 200) if flag:  # Successful match, but guard fails
...        print('Case 2')
...    case (100, y):  # Matches and binds y to 200
...        print(f'Case 3, y: {y}')
...    case _:  # Pattern not attempted
...        print('Case 4, I match anything!')
...
Case 3, y: 200

Neste caso, if flag é um guard. Leia mais sobre isso na próxima seção.

8.6.2. Guards

guard ::=  "if" named_expression

Um guard (que faz parte do case) deve ter sucesso para que o código dentro do bloco case seja executado. Ele assume a forma: if seguido por uma expressão.

O fluxo lógico de um bloco case com um guard é o seguinte:

1. Verifique se o padrão no bloco case foi bem-sucedido. Se o padrão falhou, o guard não é avaliado e o próximo bloco case é verificado.

2. Se o padrão for bem-sucedido, avalia o guard.

   • Se a condição guard for avaliada como verdadeira, o bloco de caso será selecionado.

   • Se a condição guard for avaliada como falsa, o bloco de caso não será selecionado.

   • Se o guard levantar uma exceção durante a avaliação, a exceção surgirá.

Guards podem ter efeitos colaterais, pois são expressões. A avaliação de guards deve prosseguir do primeiro ao último bloco de caso, um de cada vez, pulando blocos de caso cujos padrões não são todos bem-sucedidos. (Isto é, a avaliação de guardas deve acontecer em ordem.) A avaliação de guards deve parar quando um bloco de caso for selecionado.

8.6.3. Blocos irrefutáveis de case

Um bloco irrefutável de case é um bloco de case que corresponde a qualquer valor. Uma instrução match pode ter no máximo um bloco irrefutável de case, e ele deve ser o último.

Um bloco de case é considerado irrefutável se não tiver guard e seu padrão for irrefutável. Um padrão é considerado irrefutável se pudermos provar somente por sua sintaxe que ele sempre terá sucesso. Somente os seguintes padrões são irrefutáveis:

• Padrões AS cujo lado esquerdo é irrefutável

• Padrões OR contendo pelo menos um padrão irrefutável

• Padrões de captura

• Padrões curingas

• padrões irrefutáveis entre parêteses

8.6.4. Padrões

Nota

Esta seção usa notações de gramática para além do padrão de EBNF:

• a notação SEP.RULE+ é uma abreviação para RULE (SEP RULE)*

• a notação !RULE é uma abreviação para uma asserção de negação antecipada.

Esta é a sintaxe de nível superior para patterns (padrões):

patterns       ::=  open_sequence_pattern | pattern
pattern        ::=  as_pattern | or_pattern
closed_pattern ::=  | literal_pattern
                    | capture_pattern
                    | wildcard_pattern
                    | value_pattern
                    | group_pattern
                    | sequence_pattern
                    | mapping_pattern
                    | class_pattern

As descrições abaixo incluirão uma descrição “em termos simples” de o que o padrão faz para fins ilustrativos (créditos a Raymond Hettinger pelo documento que inspirou a maioria das descrições). Note que essas descrições são puramente para fins ilustrativos, e não necessariamente refletem a implementação subjacente. Além disso, elas não cobrem todas as formas válidas.

8.6.4.1. Padrões OR

Um padrão OR é composto por dois ou mais padrões separados por barras verticais |. Sintaxe:

or_pattern ::=  "|".closed_pattern+

Somente o último subpadrão pode ser irrefutável, e cada subpadrão deve vincular o mesmo conjunto de nomes para evitar ambiguidades.

Um padrão OR testa a correspondência de cada um dos seus subpadrões, em sequência, ao valor do sujeito, até que uma delas seja bem sucedida. O padrão OR é então considerado bem sucedido. Caso contrário, se todas elas falharam, o padrão OR falhou.

Em termos simples, P1 | P2 | ... vai tentar fazer corresponder P1, se falhar vai tentar P2, declarando sucesso se houver sucesso em qualquer uma das tentativas, e falhando caso contrário.

8.6.4.2. Padrões AS

Um padrão AS corresponde a um padrão OR à esquerda da palavra reservada as de um assunto. Sintaxe:

as_pattern ::=  or_pattern "as" capture_pattern

Se o padrão OR falhar, o padrão AS falhará. Caso contrário, o padrão AS vincula o assunto ao nome à direita da palavra-chave as e obtém sucesso. capture_pattern não pode ser um _.

Em termos simples, P as NAME corresponderá a P e, em caso de sucesso, definirá NAME = <assunto>.

8.6.4.3. Padrões literais

Um padrão literal corresponde à maioria dos literais em Python. Sintaxe:

literal_pattern ::=  signed_number
                     | signed_number "+" NUMBER
                     | signed_number "-" NUMBER
                     | strings
                     | "None"
                     | "True"
                     | "False"
                     | signed_number: NUMBER | "-" NUMBER

A regra strings e o token NUMBER são definidos na gramática Python padrão. Strings entre aspas triplas são suportadas. Strings brutas e strings de bytes são suportadas. Literais de string formatados não são suportadas.

As formas signed_number '+' NUMBER e signed_number '-' NUMBER são para expressar números complexos; elas requerem um número real à esquerda e um número imaginário à direita. Por exemplo, 3 + 4j.

Em termos simples, LITERAL terá sucesso somente se <assunto> == LITERAL. Para os singletons None, True e False, o operador is é usado.

8.6.4.4. Padrões de captura

Um padrão de captura vincula o valor do assunto a um nome. Sintaxe:

capture_pattern ::=  !'_' NAME

Um único sublinhado _ não é um padrão de captura (é o que !'_' expressa). Em vez disso, ele é tratado como um wildcard_pattern.

Em um determinado padrão, um determinado nome só pode ser vinculado uma vez. Por exemplo, case x, x: ... é inválido enquanto case [x] | x: ... é permitido.

Os padrões de captura sempre são bem-sucedidos. A vinculação segue regras de escopo estabelecidas pelo operador de expressão de atribuição na PEP 572; o nome se torna uma variável local no escopo de função de contenção mais próximo, a menos que haja uma instrução global ou nonlocal aplicável.

Em termos simples, NAME sempre terá sucesso e definirá NAME = <assunto>.

8.6.4.5. Padrões curingas

Um padrão curinga sempre tem sucesso (corresponde a qualquer coisa) e não vincula nenhum nome. Sintaxe:

wildcard_pattern ::=  '_'

_ é uma palavra reservada contextual dentro de qualquer padrão, mas somente dentro de padrões. É um identificador, como de costume, mesmo dentro de expressões de assunto matchs, guards e blocos case.

Em termos simples, _ sempre terá sucesso.

8.6.4.6. Padrões de valor

Um padrão de valor representa um valor nomeado em Python. Sintaxe:

value_pattern ::=  attr
attr          ::=  name_or_attr "." NAME
name_or_attr  ::=  attr | NAME

O nome pontilhado no padrão é pesquisado usando as regras de resolução de nomes padrão do Python. O padrão é bem-sucedido se o valor encontrado for comparado igual ao valor do assunto (usando o operador de igualdade ==).

Em termos simples, NAME1.NAME2 terá sucesso somente se <assunto> == NAME1.NAME2

Nota

Se o mesmo valor ocorrer várias vezes na mesma instrução match, o interpretador pode armazenar em cache o primeiro valor encontrado e reutilizá-lo em vez de repetir a mesma pesquisa. Esse cache é estritamente vinculado a uma determinada execução de uma determinada instrução match.

8.6.4.7. Padrões de grupo

Um padrão de grupo permite que os usuários adicionem parênteses em torno de padrões para enfatizar o agrupamento pretendido. Caso contrário, não há sintaxe adicional. Sintaxe:

group_pattern ::=  "(" pattern ")"

Em termos simples, (P) tem o mesmo efeito que P.

8.6.4.8. Padrões de sequência

Um padrão de sequência contém vários subpadrões a serem correspondidos com elementos de sequência. A sintaxe é similar ao desempacotamento de uma lista ou tupla.

sequence_pattern       ::=  "[" [maybe_sequence_pattern] "]"
                            | "(" [open_sequence_pattern] ")"
open_sequence_pattern  ::=  maybe_star_pattern "," [maybe_sequence_pattern]
maybe_sequence_pattern ::=  ",".maybe_star_pattern+ ","?
maybe_star_pattern     ::=  star_pattern | pattern
star_pattern           ::=  "*" (capture_pattern | wildcard_pattern)

Não há diferença se parênteses ou colchetes são usados para padrões de sequência (por exemplo, (...) vs [...]).

Nota

Um único padrão entre parênteses sem uma vírgula final (por exemplo, (3 | 4)) é um padrão de grupo. Enquanto um único padrão entre colchetes (por exemplo, [3 | 4]) ainda é um padrão de sequência.

No máximo um subpadrão de estrela pode estar em um padrão de sequência. O subpadrão de estrela pode ocorrer em qualquer posição. Se nenhum subpadrão de estrela estiver presente, o padrão de sequência é um padrão de sequência de comprimento fixo; caso contrário, é um padrão de sequência de comprimento variável.

A seguir está o fluxo lógico para corresponder um padrão de sequência com um valor de assunto:

1. Se o valor do assunto não for uma sequência 2, o padrão de sequência falhará.

2. Se o valor do assunto for uma instância de str, bytes ou bytearray, o padrão de sequência falhará.

3. As etapas subsequentes dependem se o padrão de sequência é fixo ou de comprimento variável.

   Se o padrão de sequência for de comprimento fixo:

   1. Se o comprimento da sequência do assunto não for igual ao número de subpadrões, o padrão da sequência falha

   2. Subpadrões no padrão de sequência são correspondidos aos seus itens correspondentes na sequência de assunto da esquerda para a direita. A correspondência para assim que um subpadrão falha. Se todos os subpadrões tiverem sucesso em corresponder ao seu item correspondente, o padrão de sequência é bem-sucedido.

   Caso contrário, se o padrão de sequência for de comprimento variável:

   1. Se o comprimento da sequência do assunto for menor que o número de subpadrões não-estrela, o padrão da sequência falha.

   2. Os principais subpadrões não estelares são correspondidos aos seus itens correspondentes, como nas sequências de comprimento fixo.

   3. Se a etapa anterior for bem-sucedida, o subpadrão estrela corresponde a uma lista formada pelos itens de assunto restantes, excluindo os itens restantes correspondentes aos subpadrões não-estrela que seguem o subpadrão estrela.

   4. Os subpadrões não-estrela restantes são correspondidos aos seus itens de assunto correspondentes, como em uma sequência de comprimento fixo.

   Nota

   O comprimento da sequência de assunto é obtido via len() (ou seja, via protocolo __len__()). Esse comprimento pode ser armazenado em cache pelo interpretador de forma similar a padrões de valor.

Em termos simples, [P1, P2, P3, … , P<N>] corresponde somente se tudo o seguinte acontecer:

• verifica se <subject> é uma sequência

• len(subject) == <N>

• P1 corresponde a <subject>[0] (observe que esta correspondência também pode vincular nomes)

• P2 corresponde a <subject>[1] (observe que esta correspondência também pode vincular nomes)

• … e assim por diante para o padrão/elemento correspondente.

8.6.4.9. Padrões de mapeamento

Um padrão de mapeamento contém um ou mais padrões de chave-valor. A sintaxe é similar à construção de um dicionário. Sintaxe:

mapping_pattern     ::=  "{" [items_pattern] "}"
items_pattern       ::=  ",".key_value_pattern+ ","?
key_value_pattern   ::=  (literal_pattern | value_pattern) ":" pattern
                         | double_star_pattern
double_star_pattern ::=  "**" capture_pattern

No máximo um padrão de estrela dupla pode estar em um padrão de mapeamento. O padrão de estrela dupla deve ser o último subpadrão no padrão de mapeamento.

Chaves duplicadas em padrões de mapeamento não são permitidas. Chaves literais duplicadas levantarão um SyntaxError. Duas chaves que de outra forma têm o mesmo valor levantarão ValueError em tempo de execução.

A seguir está o fluxo lógico para comparar um padrão de mapeamento com um valor de assunto:

1. Se o valor do assunto não for um mapeamento 3, o padrão de mapeamento falhará.

2. Se cada chave fornecida no padrão de mapeamento estiver presente no mapeamento de assunto, e o padrão para cada chave corresponder ao item correspondente do mapeamento de assunto, o padrão de mapeamento será bem-sucedido.

3. Se chaves duplicadas forem detectadas no padrão de mapeamento, o padrão será considerado inválido. Uma exceção SyntaxError é levantada para valores literais duplicados; ou ValueError para chaves nomeadas do mesmo valor.

Nota

Key-value pairs are matched using the two-argument form of the mapping subject’s get() method. Matched key-value pairs must already be present in the mapping, and not created on-the-fly via __missing__() or __getitem__().

Em termos simples, {KEY1: P1, KEY2: P2, ... } corresponde somente se tudo o seguinte acontecer:

• verifica se <assunto> é um mapeamento

• KEY1 in <assunto>

• P1 corresponde a <assunto>[KEY1]

• … e assim por diante para o par KEY/elemento correspondente.

8.6.4.10. Padrões de classe

Um padrão de classe representa uma classe e seus argumentos nomeados e posicionais (se houver). Sintaxe:

class_pattern       ::=  name_or_attr "(" [pattern_arguments ","?] ")"
pattern_arguments   ::=  positional_patterns ["," keyword_patterns]
                         | keyword_patterns
positional_patterns ::=  ",".pattern+
keyword_patterns    ::=  ",".keyword_pattern+
keyword_pattern     ::=  NAME "=" pattern

O mesmo argumento nomeado não deve ser repetido em padrões de classe.

A seguir está o fluxo lógico para corresponder a um padrão de classe com um valor de assunto:

1. Se name_or_attr não for uma instância do tipo embutido type , levanta TypeError.

2. Se o valor do assunto não for uma instância de name_or_attr (testado via isinstance()), o padrão de classe falhará.

3. Se nenhum argumento de padrão estiver presente, o padrão é bem-sucedido. Caso contrário, as etapas subsequentes dependem se os padrões de argumento posicional ou nomeado estão presentes.

   Para vários tipos embutidos (especificados abaixo), um único subpadrão posicional é aceito, o qual corresponderá a todo o assunto; para esses tipos, os padrões de argumentos nomeados também funcionam como para outros tipos.

   Se apenas padrões de argumentos nomeados estiverem presentes, eles serão processados da seguinte forma, um por um:

   I. A palavra-chave é procurada como um atributo no assunto.

   • Se isso levantar uma exceção diferente de AttributeError, a exceção será exibida.

   • Se isso levantar AttributeError, o padrão de classe falhou.

   • Caso contrário, o subpadrão associado ao padrão de argumento nomeado é correspondido ao valor de atributo do sujeito. Se isso falhar, o padrão de classe falha; se isso for bem-sucedido, a correspondência prossegue para o próximo argumento nomeado.

   II. Se todos os padrões de argumento nomeado forem bem-sucedidos, o padrão de classe será bem-sucedido.

   Se houver algum padrão posicional presente, ele será convertido em padrões de argumento nomeado usando o atributo __match_args__ na classe name_or_attr antes da correspondência:

   I. O equivalente de getattr(cls, "__match_args__", ()) é chamado.

   • Se isso levantar uma exceção, a exceção surgirá.

   • Se o valor retornado não for uma tupla, a conversão falhará e TypeError será levantada.

   • Se houver mais padrões posicionais do que len(cls.__match_args__), TypeError será levantada.

   • Caso contrário, o padrão posicional i é convertido em um padrão de argumento nomeado usando __match_args__[i] como argumento nomeado. __match_args__[i] deve ser uma string; caso contrário, TypeError é levantada.

   • Se houver argumentos nomeados duplicados, TypeError será levantada.

   Ver também

   Customizando argumentos posicionais na classe correspondência de padrão

   II. Uma vez que todos os padrões posicionais foram convertidos em padrões de argumentos nomeados,

   a partida prossegue como se houvesse apenas padrões de argumentos nomeados.

   Para os seguintes tipos embutidos, o tratamento de subpadrões posicionais é diferente:

   • bool

   • bytearray

   • bytes

   • dict

   • float

   • frozenset

   • int

   • list

   • set

   • str

   • tuple

   Essas classes aceitam um único argumento posicional, e o padrão ali é correspondido ao objeto inteiro em vez de um atributo. Por exemplo, int(0|1) corresponde ao valor 0, mas não ao valor 0.0.

Em termos simples, CLS(P1, attr=P2) corresponde somente se o seguinte acontecer:

• isinstance(<assunto>, CLS)

• converte P1 em um padrão de argumento nomeado usando CLS.__match_args__

• Para cada argumento de palavra-chave attr=P2:

  • hasattr(<assunto>, "attr")

  • P2 corresponde a <assunto>.attr

• … e assim por diante para o par argumento nomeado/elemento correspondente.

Ver também

• PEP 634 – Structural Pattern Matching: Specification

• PEP 636 – Correspondência de padrões estruturais: Tutorial

8.7. Definições de função

Uma definição de função define um objeto de função definido pelo usuário (veja a seção A hierarquia de tipos padrão):

funcdef                   ::=  [decorators] "def" funcname "(" [parameter_list] ")"
                               ["->" expression] ":" suite
decorators                ::=  decorator+
decorator                 ::=  "@" assignment_expression NEWLINE
parameter_list            ::=  defparameter ("," defparameter)* "," "/" ["," [parameter_list_no_posonly]]
                                 | parameter_list_no_posonly
parameter_list_no_posonly ::=  defparameter ("," defparameter)* ["," [parameter_list_starargs]]
                               | parameter_list_starargs
parameter_list_starargs   ::=  "*" [parameter] ("," defparameter)* ["," ["**" parameter [","]]]
                               | "**" parameter [","]
parameter                 ::=  identifier [":" expression]
defparameter              ::=  parameter ["=" expression]
funcname                  ::=  identifier

Uma definição de função é uma instrução executável. Sua execução vincula o nome da função no espaço de nomes local atual a um objeto função (um invólucro em torno do código executável para a função). Este objeto função contém uma referência ao espaço de nomes global atual como o espaço de nomes global a ser usado quando a função é chamada.

A definição da função não executa o corpo da função; ela é executada somente quando a função é chamada. 4

Uma definição de função pode ser encapsulada por uma ou mais expressões decoradoras. Expressões decoradoras são avaliadas quando a função é definida, no escopo que contém a definição da função. O resultado deve ser um chamável, que é invocado com o objeto de função como o único argumento. O valor retornado é vinculado ao nome da função em vez do objeto de função. Vários decoradores são aplicados de forma aninhada. Por exemplo, o código a seguir

@f1(arg)
@f2
def func(): pass

é aproximadamente equivalente a

def func(): pass
func = f1(arg)(f2(func))

exceto que a função original não está temporariamente vinculada ao nome func.

Alterado na versão 3.9: Funções podem ser decoradas com qualquer assignment_expression válida. Anteriormente, a gramática era muito mais restritiva; veja PEP 614 para detalhes.

Quando um ou mais parâmetros têm a forma parameter = expression, diz-se que a função tem “valores de parâmetro padrão”. Para um parâmetro com um valor padrão, o argumento correspondente pode ser omitido de uma chamada, em cujo caso o valor padrão do parâmetro é substituído. Se um parâmetro tiver um valor padrão, todos os parâmetros seguintes até “*” também devem ter um valor padrão — esta é uma restrição sintática que não é expressa pela gramática.

Os valores de parâmetro padrão são avaliados da esquerda para a direita quando a definição da função é executada. Isso significa que a expressão é avaliada uma vez, quando a função é definida, e que o mesmo valor “pré-calculado” é usado para cada chamada. Isso é especialmente importante para entender quando um valor de parâmetro padrão é um objeto mutável, como uma lista ou um dicionário: se a função modifica o objeto (por exemplo, anexando um item a uma lista), o valor de parâmetro padrão é efetivamente modificado. Isso geralmente não é o que se pretendia. Uma maneira de contornar isso é usar None como o padrão e testá-lo explicitamente no corpo da função, por exemplo:

def whats_on_the_telly(penguin=None):
    if penguin is None:
        penguin = []
    penguin.append("property of the zoo")
    return penguin

A semântica de chamada de função é descrita em mais detalhes na seção Chamadas. Uma chamada de função sempre atribui valores a todos os parâmetros mencionados na lista de parâmetros, seja de argumentos posicionais, de argumentos nomeados ou de valores padrão. Se o formato “*identifier” estiver presente, ele será inicializado para uma tupla que recebe quaisquer parâmetros posicionais excedentes, padronizando para a tupla vazia. Se o formato “**identifier” estiver presente, ele será inicializado para um novo mapeamento ordenado que recebe quaisquer argumentos nomeados excedentes, padronizando para um novo mapeamento vazio do mesmo tipo. Parâmetros após “*” ou “*identifier” são parâmetros somente-nomeados e podem ser passados somente por argumentos nomeados. Parâmetros antes de “/” são parâmetros somente-posicionais e podem ser passados somente por argumentos posicionais.

Alterado na versão 3.8: A sintaxe do parâmetro de função / pode ser usada para indicar parâmetros somente-posicionais. Veja a PEP 570 para detalhes.

Parameters may have an annotation of the form “: expression” following the parameter name. Any parameter may have an annotation, even those of the form *identifier or **identifier. Functions may have “return” annotation of the form “-> expression” after the parameter list. These annotations can be any valid Python expression. The presence of annotations does not change the semantics of a function. The annotation values are available as values of a dictionary keyed by the parameters’ names in the __annotations__ attribute of the function object. If the annotations import from __future__ is used, annotations are preserved as strings at runtime which enables postponed evaluation. Otherwise, they are evaluated when the function definition is executed. In this case annotations may be evaluated in a different order than they appear in the source code.

Também é possível criar funções anônimas (funções não vinculadas a um nome), para uso imediato em expressões. Isso usa expressões lambda, descritas na seção Lambdas. Observe que a expressão lambda é meramente uma abreviação para uma definição de função simplificada; uma função definida em uma instrução “def” pode ser passada adiante ou atribuída a outro nome, assim como uma função definida por uma expressão lambda. O formato “def” é, na verdade, mais poderoso, pois permite a execução de várias instruções e anotações.

Nota do programador: Funções são objetos de primeira classe. Uma instrução “def” executada dentro de uma definição de função define uma função local que pode ser retornada ou passada adiante. Variáveis livres usadas na função aninhada podem acessar as variáveis locais da função que contém o “def”. Veja a seção Nomeação e ligação para detalhes.

Ver também

PEP 3107 - Anotações de função

A especificação original para anotações de funções.

PEP 484 - Dicas de tipo

Definição de um significado padrão para anotações: dicas de tipo.

PEP 526 - Sintaxe para Anotações de Variáveis

Ability to type hint variable declarations, including class variables and instance variables

PEP 563 - Avaliação postergada de anotações

Suporte para referências futuras dentro de anotações, preservando anotações em um formato de string em tempo de execução em vez de avaliação antecipada.

8.8. Definições de classe

Uma definição de classe define um objeto classe (veja a seção A hierarquia de tipos padrão):

classdef    ::=  [decorators] "class" classname [inheritance] ":" suite
inheritance ::=  "(" [argument_list] ")"
classname   ::=  identifier

Uma definição de classe é uma instrução executável. A lista de herança geralmente fornece uma lista de classes base (veja Metaclasses para usos mais avançados), então cada item na lista deve ser executada como um objeto classe que permite extensão via subclasse. Classes sem uma lista de herança herdam, por padrão, da classe base object; portanto,

class Foo:
    pass

equivale a

class Foo(object):
    pass

O conjunto da classe é então executado em um novo quadro de execução (veja Nomeação e ligação), usando um espaço de nomes local recém-criado e o espaço de nomes global original. (Normalmente, o conjunto contém principalmente definições de função.) Quando o conjunto da classe termina a execução, seu quadro de execução é descartado, mas seu espaço de nomes local é salvo. 5 Um objeto classe é então criado usando a lista de herança para as classes base e o espaço de nomes local salvo para o dicionário de atributos. O nome da classe é vinculado a este objeto classe no espaço de nomes local original.

The order in which attributes are defined in the class body is preserved in the new class’s __dict__. Note that this is reliable only right after the class is created and only for classes that were defined using the definition syntax.

A criação de classes pode ser bastante personalizada usando metaclasses.

As classes também podem ser decoradas: assim como na decoração de funções,

@f1(arg)
@f2
class Foo: pass

é aproximadamente equivalente a

class Foo: pass
Foo = f1(arg)(f2(Foo))

As regras de execução para as expressões de decorador são as mesmas que para decoradores de função. O resultado é então vinculado ao nome da classe.

Alterado na versão 3.9: Classes podem ser decoradas com qualquer assignment_expression válida. Anteriormente, a gramática era muito mais restritiva; veja PEP 614 para detalhes.

Nota do programador: Variáveis definidas na definição de classe são atributos de classe; elas são compartilhadas por instâncias. Atributos de instância podem ser definidos em um método com self.nome = valor. Atributos de classe e instância são acessíveis por meio da notação “self.nome”, e um atributo de instância oculta um atributo de classe com o mesmo nome quando acessado dessa forma. Atributos de classe podem ser usados como padrões para atributos de instância, mas usar valores mutáveis pode levar a resultados inesperados. Descritores podem ser usados para criar variáveis de instância com diferentes detalhes de implementação.

Ver também

PEP 3115 - Metaclasses no Python 3000

A proposta que alterou a declaração de metaclasses para a sintaxe atual e a semântica de como as classes com metaclasses são construídas.

PEP 3129 - Class Decorators

A proposta que adicionou decoradores de classe. Decoradores de função e método foram introduzidos na PEP 318.

8.9. Corrotinas

Novo na versão 3.5.

8.9.1. Definição de função de corrotina

async_funcdef ::=  [decorators] "async" "def" funcname "(" [parameter_list] ")"
                   ["->" expression] ":" suite

A execução de corrotinas do Python pode ser suspensa e retomada em muitos pontos (consulte coroutine). As expressões await, async for e async with só podem ser usadas no corpo de uma função de corrotina.

Funções definidas com a sintaxe async def são sempre funções de corrotina, mesmo que não contenham palavras reservadas await ou async.

Ocorre uma SyntaxError se usada uma expressão yield from dentro do corpo de uma função de corrotina.

Um exemplo de uma função de corrotina:

async def func(param1, param2):
    do_stuff()
    await some_coroutine()

Alterado na versão 3.7: await e async agora são palavras reservadas; anteriormente, elas só eram tratadas como tal dentro do corpo de uma função de corrotina.

8.9.2. A instrução async for

async_for_stmt ::=  "async" for_stmt

Um iterável assíncrono fornece um método __aiter__ que retorna diretamente um iterador assíncrono, que pode chamar código assíncrono em seu método __anext__.

A instrução async for permite iteração conveniente sobre iteráveis assíncronos.

O seguinte código:

async for TARGET in ITER:
    SUITE
else:
    SUITE2

É semanticamente equivalente a:

iter = (ITER)
iter = type(iter).__aiter__(iter)
running = True

while running:
    try:
        TARGET = await type(iter).__anext__(iter)
    except StopAsyncIteration:
        running = False
    else:
        SUITE
else:
    SUITE2

Veja também __aiter__() e __anext__() para detalhes.

Ocorre uma SyntaxError se usada uma instrução async for fora do corpo de uma função de corrotina.

8.9.3. A instrução async with

async_with_stmt ::=  "async" with_stmt

Um gerenciador de contexto assíncrono é um gerenciador de contexto que é capaz de suspender a execução em seus métodos enter e exit.

O seguinte código:

async with EXPRESSION as TARGET:
    SUITE

é semanticamente equivalente a:

manager = (EXPRESSION)
aenter = type(manager).__aenter__
aexit = type(manager).__aexit__
value = await aenter(manager)
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not await aexit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        await aexit(manager, None, None, None)

Veja também __aenter__() e __aexit__() para detalhes.

Ocorre uma SyntaxError se usada uma instrução async with fora do corpo de uma função de corrotina.

Ver também

PEP 492 - Corrotina com sintaxe de async e wait

A proposta que tornou as corrotinas um conceito autônomo em Python e adicionou sintaxe de suporte.

Notas de rodapé

1

A exceção é propagada para a pilha de invocação, a menos que haja uma cláusula finally que por acaso levante outra exceção. Essa nova exceção faz com que a antiga seja perdida.

2

Na correspondência de padrões, uma sequência é definida como uma das seguintes:

• uma classe que herda de collections.abc.Sequence

• uma classe Python que foi registrada como collections.abc.Sequence

• a builtin class that has its (CPython) Py_TPFLAGS_SEQUENCE bit set

• uma classe que herda de qualquer uma das anteriores

As seguintes classes de biblioteca padrão são sequências:

• array.array

• collections.deque

• list

• memoryview

• range

• tuple

Nota

Valores de assunto do tipo str, bytes e bytearray não correspondem aos padrões de sequência.

3

Na correspondência de padrões, um mapeamento é definido como uma das seguintes:

• uma classe que herda de collections.abc.Mapping

• uma classe Python que foi registrada como collections.abc.Mapping

• a builtin class that has its (CPython) Py_TPFLAGS_MAPPING bit set

• uma classe que herda de qualquer uma das anteriores

As classes de biblioteca padrão dict e types.MappingProxyType são mapeamentos.

4

A string literal appearing as the first statement in the function body is transformed into the function’s __doc__ attribute and therefore the function’s docstring.

5

A string literal appearing as the first statement in the class body is transformed into the namespace’s __doc__ item and therefore the class’s docstring.