# 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" starred_list ":" suite
                  ["else" ":" suite]

A expressão `starred_list` é avaliada uma vez; deve produzir um objeto iterável. Um iterador é criado para esse iterável. O primeiro item fornecido pelo iterador é então atribuído à lista de alvos usando as regras padrão para atribuições (veja Instruções de atribuição), e o conjunto é executado. Isso se repete para cada item fornecido pelo iterador. Quando o iterador se esgota, o conjunto na cláusula `else`, se presente, é executado e o loop 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 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.

Alterado na versão 3.11: Elementos marcados com estrela agora são permitidos na lista de expressões.

## 8.4. A instrução `try`

A instrução `try` especifica manipuladores de exceção e/ou código de limpeza para um grupo de instruções:

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

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.

### 8.4.1. Cláusula `except`

A(s) cláusula(s) `except` especifica(m) um ou mais manipuladores de exceção. Quando nenhuma exceção ocorre na cláusula `try`, nenhum manipulador de exceção é executado. Quando ocorre uma exceção no conjunto `try`, uma busca por um manipulador de exceção é iniciada. Esta pesquisa inspeciona as cláusulas `except` sucessivamente até que seja encontrada uma que corresponda à exceção. Uma cláusula `except` sem expressão, se presente, deve ser a última; corresponde a qualquer exceção. Para uma cláusula `except` com uma expressão, essa expressão é avaliada e a cláusula corresponde à exceção se o objeto resultante for “compatível” com a exceção. Um objeto é compatível com uma exceção se o objeto for a classe ou uma classe base não virtual do objeto de exceção, ou uma tupla contendo um item que seja a classe ou uma classe base não virtual do objeto de exceção.

Se nenhuma cláusula `except` corresponder à exceção, a busca por um manipulador de exceção continua no código circundante e na pilha de invocação. [1]

Se a avaliação de uma expressão no cabeçalho de uma cláusula `except` levantar uma exceção, a busca original por um manipulador será cancelada e uma busca pela nova exceção será iniciada no código circundante e na pilha de chamadas (ela é tratado como se toda a instrução `try` levantasse a exceção).

Quando uma cláusula `except` correspondente é encontrada, a exceção é atribuída ao destino especificado após a palavra reservada `as` nessa cláusula `except`, se presente, e o conjunto da cláusula `except` é executado. Todas as cláusulas `except` devem ter um bloco executável. Quando o final deste bloco é atingido, a execução continua normalmente após toda a instrução `try`. (Isso significa que se existirem dois manipuladores aninhados para a mesma exceção, e a exceção ocorrer na cláusula `try` do manipulador interno, o manipulador externo não tratará a exceção.)

Quando uma exceção foi atribuída usando `as target`, ela é limpa no final da cláusula `except`. É como se

    except E as N:
        foo

fosse traduzido para

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

Isso significa que a exceção deve ser atribuída a um nome diferente para poder referenciá-la após a cláusula `except`. As exceções são limpas porque, com o traceback (situação da pilha de execução) anexado a elas, elas formam um ciclo de referência com o quadro de pilha, mantendo todos os locais nesse quadro vivos até que ocorra a próxima coleta de lixo.

Antes de um conjunto de cláusulas `except` ser executado, a exceção é armazenada no módulo `sys`, onde pode ser acessada de dentro do corpo da cláusula `except` chamando `sys.exception()`. Ao sair de um manipulador de exceções, a exceção armazenada no módulo `sys` é redefinida para seu valor anterior:

    >>> print(sys.exception())
    None
    >>> try:
    ...     raise TypeError
    ... except:
    ...     print(repr(sys.exception()))
    ...     try:
    ...          raise ValueError
    ...     except:
    ...         print(repr(sys.exception()))
    ...     print(repr(sys.exception()))
    ...
    TypeError()
    ValueError()
    TypeError()
    >>> print(sys.exception())
    None

### 8.4.2. Cláusula `except*`

As cláusulas `except*` são usadas para manipular `ExceptionGroup`s. O tipo de exceção para correspondência é interpretado como no caso de `except`, mas no caso de grupos de exceção, podemos ter correspondências parciais quando o tipo corresponde a algumas das exceções no grupo. Isso significa que várias cláusulas `except*` podem ser executadas, cada uma manipulando parte do grupo de exceções. Cada cláusula é executada no máximo uma vez e manipula um grupo de exceções de todas as exceções correspondentes. Cada exceção no grupo é manipulada por no máximo uma cláusula `except*`, a primeira que corresponde a ela.

    >>> try:
    ...     raise ExceptionGroup("eg",
    ...         [ValueError(1), TypeError(2), OSError(3), OSError(4)])
    ... except* TypeError as e:
    ...     print(f'caught {type(e)} with nested {e.exceptions}')
    ... except* OSError as e:
    ...     print(f'caught {type(e)} with nested {e.exceptions}')
    ...
    caught <class 'ExceptionGroup'> with nested (TypeError(2),)
    caught <class 'ExceptionGroup'> with nested (OSError(3), OSError(4))
      + Exception Group Traceback (most recent call last):
      |   File "<stdin>", line 2, in <module>
      | ExceptionGroup: eg
      +-+---------------- 1 ----------------
        | ValueError: 1
        +------------------------------------

Any remaining exceptions that were not handled by any `except*` clause are re-raised at the end, combined into an exception group along with all exceptions that were raised from within `except*` clauses.

From version 3.11.4, when the entire `ExceptionGroup` is handled and only one exception is raised from an `except*` clause, this exception is no longer wrapped to form a new `ExceptionGroup`.

Se a exceção levantada não for um grupo de exceções e seu tipo corresponder a uma das cláusulas `except*`, ela será capturada e encapsulada por um grupo de exceções com uma string de mensagem vazia.

    >>> try:
    ...     raise BlockingIOError
    ... except* BlockingIOError as e:
    ...     print(repr(e))
    ...
    ExceptionGroup('', (BlockingIOError()))

An `except*` clause must have a matching type, and this type cannot be a subclass of `BaseExceptionGroup`. It is not possible to mix `except` and `except*` in the same `try`. `break`, `continue` and `return` cannot appear in an `except*` clause.

### 8.4.3. Cláusula `else`

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.

### 8.4.4. Cláusula `finally`

Se `finally` estiver presente, especifica um manipulador de “limpeza”. A cláusula `try` é executada, incluindo quaisquer cláusulas `except` e `else`. Se uma exceção ocorrer em qualquer uma das cláusulas e não for manipulada, a exceção será salva temporariamente. A cláusula `finally` é executada. Se houver uma exceção salva, ela será levantada novamente no final da cláusula `finally`. Se a cláusula `finally` levantar outra exceção, a exceção salva será definida como o contexto da nova exceção. Se a cláusula `finally` executar uma instrução `return`, `break` ou `continue`, a exceção salva será descartada:

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

As informações de exceção não estão disponíveis para o programa durante a execução da cláusula `finally`.

Quando uma instrução `return`, `break` ou `continue` é executada no conjunto `try` de uma instrução `try`…`finally`, a cláusula `finally` também é executada “na saída”.

O valor de retorno de uma função é determinado pela última instrução `return` executada. Como a cláusula `finally` sempre é executada, uma instrução `return` executada na cláusula `finally` sempre será a última executada:

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

Alterado na versão 3.8: Antes do Python 3.8, uma instrução `continue` era ilegal na cláusula `finally` devido a um problema com a implementação.

## 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. O `__enter__()` do gerenciador de contexto é carregado para uso posterior.

3. O `__exit__()` do gerenciador de contexto é carregado para uso posterior.

4. O método `__enter__()` do gerenciador de contexto é invocado.

5. Se um alvo foi incluído na instrução `with`, o valor de retorno de `__enter__()` é atribuído a ele.

   Nota

   A instrução `with` garante que se o método `__enter__()` retornar sem um erro, então `__exit__()` sempre será chamado. Assim, se ocorrer um erro durante a atribuição à lista de alvos, ele será tratado da mesma forma que um erro ocorrendo dentro do conjunto seria. Veja a etapa 7 abaixo.

6. O conjunto é executado.

7. O método `__exit__()` do gerenciador de contexto é invocado. Se uma exceção fez com que o conjunto fosse encerrado, seu tipo, valor e traceback são passados ​como argumentos para `__exit__()`. Caso contrário, três argumentos `None` são fornecidos.

   Se o conjunto foi encerrado devido a uma exceção, e o valor de retorno do método `__exit__()` foi falso, a exceção é levantada novamente. Se o valor de retorno era verdadeiro, a exceção é suprimida, e a execução continua com a instrução após a instrução `with`.

   Se o conjunto foi encerrado por qualquer motivo diferente de uma exceção, o valor de retorno de `__exit__()` é ignorado e a execução prossegue no local normal para o tipo de saída que foi realizada.

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

- Capture Patterns

- Wildcard Patterns

- 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

An AS pattern matches an OR pattern on the left of the `as` keyword against a subject. Syntax:

    as_pattern ::=  or_pattern "as" capture_pattern

If the OR pattern fails, the AS pattern fails. Otherwise, the AS pattern binds the subject to the name on the right of the as keyword and succeeds. `capture_pattern` cannot be a `_`.

In simple terms `P as NAME` will match with `P`, and on success it will set `NAME = <subject>`.

#### 8.6.4.3. Literal Patterns

A literal pattern corresponds to most literals in Python. Syntax:

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

The rule `strings` and the token `NUMBER` are defined in the standard Python grammar. Triple-quoted strings are supported. Raw strings and byte strings are supported. Literais de strings formatadas are not supported.

The forms `signed_number '+' NUMBER` and `signed_number '-' NUMBER` are for expressing complex numbers; they require a real number on the left and an imaginary number on the right. E.g. `3 + 4j`.

In simple terms, `LITERAL` will succeed only if `<subject> == LITERAL`. For the singletons `None`, `True` and `False`, the `is` operator is used.

#### 8.6.4.4. Capture Patterns

A capture pattern binds the subject value to a name. Syntax:

    capture_pattern ::=  !'_' NAME

A single underscore `_` is not a capture pattern (this is what `!'_'` expresses). It is instead treated as a `wildcard_pattern`.

In a given pattern, a given name can only be bound once. E.g. `case x, x: ...` is invalid while `case [x] | x: ...` is allowed.

Capture patterns always succeed. The binding follows scoping rules established by the assignment expression operator in PEP 572; the name becomes a local variable in the closest containing function scope unless there’s an applicable `global` or `nonlocal` statement.

In simple terms `NAME` will always succeed and it will set `NAME = <subject>`.

#### 8.6.4.5. Wildcard Patterns

A wildcard pattern always succeeds (matches anything) and binds no name. Syntax:

    wildcard_pattern ::=  '_'

`_` is a soft keyword within any pattern, but only within patterns. It is an identifier, as usual, even within `match` subject expressions, `guard`s, and `case` blocks.

In simple terms, `_` will always succeed.

#### 8.6.4.6. Value Patterns

A value pattern represents a named value in Python. Syntax:

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

The dotted name in the pattern is looked up using standard Python name resolution rules. The pattern succeeds if the value found compares equal to the subject value (using the `==` equality operator).

In simple terms `NAME1.NAME2` will succeed only if `<subject> == NAME1.NAME2`

Nota

If the same value occurs multiple times in the same match statement, the interpreter may cache the first value found and reuse it rather than repeat the same lookup. This cache is strictly tied to a given execution of a given match statement.

#### 8.6.4.7. Group Patterns

A group pattern allows users to add parentheses around patterns to emphasize the intended grouping. Otherwise, it has no additional syntax. Syntax:

    group_pattern ::=  "(" pattern ")"

In simple terms `(P)` has the same effect as `P`.

#### 8.6.4.8. Sequence Patterns

A sequence pattern contains several subpatterns to be matched against sequence elements. The syntax is similar to the unpacking of a list or tuple.

    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)

There is no difference if parentheses or square brackets are used for sequence patterns (i.e. `(...)` vs `[...]` ).

Nota

A single pattern enclosed in parentheses without a trailing comma (e.g. `(3 | 4)`) is a group pattern. While a single pattern enclosed in square brackets (e.g. `[3 | 4]`) is still a sequence pattern.

At most one star subpattern may be in a sequence pattern. The star subpattern may occur in any position. If no star subpattern is present, the sequence pattern is a fixed-length sequence pattern; otherwise it is a variable-length sequence pattern.

The following is the logical flow for matching a sequence pattern against a subject value:

1. If the subject value is not a sequence [2], the sequence pattern fails.

2. If the subject value is an instance of `str`, `bytes` or `bytearray` the sequence pattern fails.

3. The subsequent steps depend on whether the sequence pattern is fixed or variable-length.

   If the sequence pattern is fixed-length:

   1. If the length of the subject sequence is not equal to the number of subpatterns, the sequence pattern fails

   2. Subpatterns in the sequence pattern are matched to their corresponding items in the subject sequence from left to right. Matching stops as soon as a subpattern fails. If all subpatterns succeed in matching their corresponding item, the sequence pattern succeeds.

   Otherwise, if the sequence pattern is variable-length:

   1. If the length of the subject sequence is less than the number of non-star subpatterns, the sequence pattern fails.

   2. The leading non-star subpatterns are matched to their corresponding items as for fixed-length sequences.

   3. If the previous step succeeds, the star subpattern matches a list formed of the remaining subject items, excluding the remaining items corresponding to non-star subpatterns following the star subpattern.

   4. Remaining non-star subpatterns are matched to their corresponding subject items, as for a fixed-length sequence.

   Nota

   The length of the subject sequence is obtained via `len()` (i.e. via the `__len__()` protocol). This length may be cached by the interpreter in a similar manner as value patterns.

In simple terms `[P1, P2, P3,` … `, P<N>]` matches only if all the following happens:

- check `<subject>` is a sequence

- `len(subject) == <N>`

- `P1` matches `<subject>[0]` (note that this match can also bind names)

- `P2` matches `<subject>[1]` (note that this match can also bind names)

- … and so on for the corresponding pattern/element.

#### 8.6.4.9. Mapping Patterns

A mapping pattern contains one or more key-value patterns. The syntax is similar to the construction of a dictionary. Syntax:

    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

At most one double star pattern may be in a mapping pattern. The double star pattern must be the last subpattern in the mapping pattern.

Duplicate keys in mapping patterns are disallowed. Duplicate literal keys will raise a `SyntaxError`. Two keys that otherwise have the same value will raise a `ValueError` at runtime.

The following is the logical flow for matching a mapping pattern against a subject value:

1. If the subject value is not a mapping [3],the mapping pattern fails.

2. If every key given in the mapping pattern is present in the subject mapping, and the pattern for each key matches the corresponding item of the subject mapping, the mapping pattern succeeds.

3. If duplicate keys are detected in the mapping pattern, the pattern is considered invalid. A `SyntaxError` is raised for duplicate literal values; or a `ValueError` for named keys of the same value.

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__()`.

In simple terms `{KEY1: P1, KEY2: P2, ... }` matches only if all the following happens:

- check `<subject>` is a mapping

- `KEY1 in <subject>`

- `P1` matches `<subject>[KEY1]`

- … and so on for the corresponding KEY/pattern pair.

#### 8.6.4.10. Class Patterns

A class pattern represents a class and its positional and keyword arguments (if any). Syntax:

    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

The same keyword should not be repeated in class patterns.

The following is the logical flow for matching a class pattern against a subject value:

1. If `name_or_attr` is not an instance of the builtin `type` , raise `TypeError`.

2. If the subject value is not an instance of `name_or_attr` (tested via `isinstance()`), the class pattern fails.

3. If no pattern arguments are present, the pattern succeeds. Otherwise, the subsequent steps depend on whether keyword or positional argument patterns are present.

   For a number of built-in types (specified below), a single positional subpattern is accepted which will match the entire subject; for these types keyword patterns also work as for other types.

   If only keyword patterns are present, they are processed as follows, one by one:

   I. The keyword is looked up as an attribute on the subject.

   > - If this raises an exception other than `AttributeError`, the exception bubbles up.

   > - If this raises `AttributeError`, the class pattern has failed.

   > - Else, the subpattern associated with the keyword pattern is matched against the subject’s attribute value. If this fails, the class pattern fails; if this succeeds, the match proceeds to the next keyword.

   II. If all keyword patterns succeed, the class pattern succeeds.

   If any positional patterns are present, they are converted to keyword patterns using the `__match_args__` attribute on the class `name_or_attr` before matching:

   I. The equivalent of `getattr(cls, "__match_args__", ())` is called.

   > - If this raises an exception, the exception bubbles up.

   > - If the returned value is not a tuple, the conversion fails and `TypeError` is raised.

   > - If there are more positional patterns than `len(cls.__match_args__)`, `TypeError` is raised.

   > - Otherwise, positional pattern `i` is converted to a keyword pattern using `__match_args__[i]` as the keyword. `__match_args__[i]` must be a string; if not `TypeError` is raised.

   > - If there are duplicate keywords, `TypeError` is raised.

   > Ver também

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

   II. Once all positional patterns have been converted to keyword patterns,

     the match proceeds as if there were only keyword patterns.

   For the following built-in types the handling of positional subpatterns is different:

   - `bool`

   - `bytearray`

   - `bytes`

   - `dict`

   - `float`

   - `frozenset`

   - `int`

   - `list`

   - `set`

   - `str`

   - `tuple`

   These classes accept a single positional argument, and the pattern there is matched against the whole object rather than an attribute. For example `int(0|1)` matches the value `0`, but not the value `0.0`.

In simple terms `CLS(P1, attr=P2)` matches only if the following happens:

- `isinstance(<subject>, CLS)`

- convert `P1` to a keyword pattern using `CLS.__match_args__`

- For each keyword argument `attr=P2`:

  - `hasattr(<subject>, "attr")`

  - `P2` matches `<subject>.attr`

- … and so on for the corresponding keyword argument/pattern pair.

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

A function definition defines a user-defined function object (see section 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

A function definition is an executable statement. Its execution binds the function name in the current local namespace to a function object (a wrapper around the executable code for the function). This function object contains a reference to the current global namespace as the global namespace to be used when the function is called.

The function definition does not execute the function body; this gets executed only when the function is called. [4]

A function definition may be wrapped by one or more decorator expressions. Decorator expressions are evaluated when the function is defined, in the scope that contains the function definition. The result must be a callable, which is invoked with the function object as the only argument. The returned value is bound to the function name instead of the function object. Multiple decorators are applied in nested fashion. For example, the following code

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

is roughly equivalent to

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

except that the original function is not temporarily bound to the name `func`.

Alterado na versão 3.9: Functions may be decorated with any valid `assignment_expression`. Previously, the grammar was much more restrictive; see PEP 614 for details.

When one or more parameters have the form parameter `=` expression, the function is said to have “default parameter values.” For a parameter with a default value, the corresponding argument may be omitted from a call, in which case the parameter’s default value is substituted. If a parameter has a default value, all following parameters up until the “`*`” must also have a default value — this is a syntactic restriction that is not expressed by the grammar.

Default parameter values are evaluated from left to right when the function definition is executed. This means that the expression is evaluated once, when the function is defined, and that the same “pre-computed” value is used for each call. This is especially important to understand when a default parameter value is a mutable object, such as a list or a dictionary: if the function modifies the object (e.g. by appending an item to a list), the default parameter value is in effect modified. This is generally not what was intended. A way around this is to use `None` as the default, and explicitly test for it in the body of the function, e.g.:

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

Function call semantics are described in more detail in section Chamadas. A function call always assigns values to all parameters mentioned in the parameter list, either from positional arguments, from keyword arguments, or from default values. If the form “`*identifier`” is present, it is initialized to a tuple receiving any excess positional parameters, defaulting to the empty tuple. If the form “`**identifier`” is present, it is initialized to a new ordered mapping receiving any excess keyword arguments, defaulting to a new empty mapping of the same type. Parameters after “`*`” or “`*identifier`” are keyword-only parameters and may only be passed by keyword arguments. Parameters before “`/`” are positional-only parameters and may only be passed by positional arguments.

Alterado na versão 3.8: The `/` function parameter syntax may be used to indicate positional-only parameters. See PEP 570 for details.

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.

It is also possible to create anonymous functions (functions not bound to a name), for immediate use in expressions. This uses lambda expressions, described in section Lambdas. Note that the lambda expression is merely a shorthand for a simplified function definition; a function defined in a “`def`” statement can be passed around or assigned to another name just like a function defined by a lambda expression. The “`def`” form is actually more powerful since it allows the execution of multiple statements and annotations.

Programmer’s note: Functions are first-class objects. A “`def`” statement executed inside a function definition defines a local function that can be returned or passed around. Free variables used in the nested function can access the local variables of the function containing the def. See section Nomeação e ligação for details.

Ver também

PEP 3107 - Function Annotations

  The original specification for function annotations.

PEP 484 - Dicas de tipo

  Definition of a standard meaning for annotations: type hints.

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

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

PEP 563 - Postponed Evaluation of Annotations

  Support for forward references within annotations by preserving annotations in a string form at runtime instead of eager evaluation.

PEP 318 - Decorators for Functions and Methods

  Function and method decorators were introduced. Class decorators were introduced in PEP 3129.

## 8.8. Definições de classe

A class definition defines a class object (see section A hierarquia de tipos padrão):

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

A class definition is an executable statement. The inheritance list usually gives a list of base classes (see Metaclasses for more advanced uses), so each item in the list should evaluate to a class object which allows subclassing. Classes without an inheritance list inherit, by default, from the base class `object`; hence,

    class Foo:
        pass

é equivalente a

    class Foo(object):
        pass

The class’s suite is then executed in a new execution frame (see Nomeação e ligação), using a newly created local namespace and the original global namespace. (Usually, the suite contains mostly function definitions.) When the class’s suite finishes execution, its execution frame is discarded but its local namespace is saved. [5] A class object is then created using the inheritance list for the base classes and the saved local namespace for the attribute dictionary. The class name is bound to this class object in the original local namespace.

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.

Class creation can be customized heavily using metaclasses.

Classes can also be decorated: just like when decorating functions,

    @f1(arg)
    @f2
    class Foo: pass

is roughly equivalent to

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

The evaluation rules for the decorator expressions are the same as for function decorators. The result is then bound to the class name.

Alterado na versão 3.9: Classes may be decorated with any valid `assignment_expression`. Previously, the grammar was much more restrictive; see PEP 614 for details.

Programmer’s note: Variables defined in the class definition are class attributes; they are shared by instances. Instance attributes can be set in a method with `self.name = value`. Both class and instance attributes are accessible through the notation “`self.name`”, and an instance attribute hides a class attribute with the same name when accessed in this way. Class attributes can be used as defaults for instance attributes, but using mutable values there can lead to unexpected results. Descriptors can be used to create instance variables with different implementation details.

Ver também

PEP 3115 - Metaclasses no Python 3000

  The proposal that changed the declaration of metaclasses to the current syntax, and the semantics for how classes with metaclasses are constructed.

PEP 3129 - Class Decorators

  The proposal that added class decorators. Function and method decorators were introduced in 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

Execution of Python coroutines can be suspended and resumed at many points (see coroutine). `await` expressions, `async for` and `async with` can only be used in the body of a coroutine function.

Functions defined with `async def` syntax are always coroutine functions, even if they do not contain `await` or `async` keywords.

It is a `SyntaxError` to use a `yield from` expression inside the body of a coroutine function.

An example of a coroutine function:

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

Alterado na versão 3.7: `await` and `async` are now keywords; previously they were only treated as such inside the body of a coroutine function.

### 8.9.2. The `async for` statement

    async_for_stmt ::=  "async" for_stmt

An asynchronous iterable provides an `__aiter__` method that directly returns an asynchronous iterator, which can call asynchronous code in its `__anext__` method.

The `async for` statement allows convenient iteration over asynchronous iterables.

O seguinte código:

    async for TARGET in ITER:
        SUITE
    else:
        SUITE2

Is semantically equivalent to:

    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

See also `__aiter__()` and `__anext__()` for details.

It is a `SyntaxError` to use an `async for` statement outside the body of a coroutine function.

### 8.9.3. The `async with` statement

    async_with_stmt ::=  "async" with_stmt

An asynchronous context manager is a context manager that is able to suspend execution in its enter and exit methods.

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)

See also `__aenter__()` and `__aexit__()` for details.

It is a `SyntaxError` to use an `async with` statement outside the body of a coroutine function.

Ver também

PEP 492 - Coroutines with async and await syntax

  The proposal that made coroutines a proper standalone concept in Python, and added supporting syntax.

Notas de rodapé

[1]

The exception is propagated to the invocation stack unless there is a `finally` clause which happens to raise another exception. That new exception causes the old one to be lost.

[2]

In pattern matching, a sequence is defined as one of the following:

- a class that inherits from `collections.abc.Sequence`

- a Python class that has been registered as `collections.abc.Sequence`

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

- a class that inherits from any of the above

The following standard library classes are sequences:

- `array.array`

- `collections.deque`

- `list`

- `memoryview`

- `range`

- `tuple`

Nota

Subject values of type `str`, `bytes`, and `bytearray` do not match sequence patterns.

[3]

In pattern matching, a mapping is defined as one of the following:

- a class that inherits from `collections.abc.Mapping`

- a Python class that has been registered as `collections.abc.Mapping`

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

- a class that inherits from any of the above

The standard library classes `dict` and `types.MappingProxyType` are mappings.

[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.