Esta documentação é de uma versão antiga do Python que não é mais atualizada. Você deveria atualizar e ler a Documentação do Python para versão estável atual.

# 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
                       | 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 laço 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

Names in the target list are not deleted when the loop is finished, but if the sequence is empty, they will not have been assigned to at all by the loop. Hint: the built-in function `range()` returns an iterator of integers suitable to emulate the effect of Pascal’s `for i := a to b do`; e.g., `list(range(3))` returns the list `[0, 1, 2]`.

Nota

There is a subtlety when the sequence is being modified by the loop (this can only occur for mutable sequences, e.g. lists). An internal counter is used to keep track of which item is used next, and this is incremented on each iteration. When this counter has reached the length of the sequence the loop terminates. This means that if the suite deletes the current (or a previous) item from the sequence, the next item will be skipped (since it gets the index of the current item which has already been treated). Likewise, if the suite inserts an item in the sequence before the current item, the current item will be treated again the next time through the loop. This can lead to nasty bugs that can be avoided by making a temporary copy using a slice of the whole sequence, e.g.,

    for x in a[:]:
        if x < 0: a.remove(x)

## 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. `sys.exc_info()` values are restored to their previous values (before the call) when returning from a function that handled an exception.

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_item ("," with_item)* ":" suite
    with_item ::=  expression ["as" target]

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

1. The context expression (the expression given in the `with_item`) is evaluated to obtain a context manager.

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 6 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

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

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

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: Functions may be decorated with any valid `assignment_expression`. Previously, the grammar was much more restrictive; see PEP 614 for details.

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.

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

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.7. 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. 3 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 may be decorated with any valid `assignment_expression`. Previously, the grammar was much more restrictive; see PEP 614 for details.

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.8. Corrotinas

Novo na versão 3.5.

### 8.8.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). Inside the body of a coroutine function, `await` and `async` identifiers become reserved keywords; `await` expressions, `async for` and `async with` can only be used in coroutine function bodies.

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()

### 8.8.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

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

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

### 8.8.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)

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

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

  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.

3

  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.