8. Instructions composées

Les instructions composées contiennent d'autres (groupes d’) instructions ; elles affectent ou contrôlent l'exécution de ces autres instructions d'une manière ou d'une autre. En général, une instruction composée couvre plusieurs lignes bien que, dans sa forme la plus simple, une instruction composée peut tenir sur une seule ligne.

Les instructions if, while et for implémentent les constructions classiques de contrôle de flux. try spécifie des gestionnaires d'exception et du code de nettoyage pour un groupe d'instructions, tandis que l'instruction with permet l'exécution de code d'initialisation et de finalisation autour d'un bloc de code. Les définitions de fonctions et de classes sont également, au sens syntaxique, des instructions composées.

Une instruction composée comporte une ou plusieurs « clauses ». Une clause se compose d'un en-tête et d'une « suite ». Les en-têtes des clauses d'une instruction composée particulière sont toutes placées au même niveau d'indentation. Chaque en-tête de clause commence par un mot-clé spécifique et se termine par le caractère deux-points (:) ; une suite est un groupe d'instructions contrôlées par une clause ; une suite se compose, après les deux points de l'en-tête, soit d'une ou plusieurs instructions simples séparées par des points-virgules si elles sont sur la même ligne que l'en-tête, soit d'une ou plusieurs instructions en retrait sur les lignes suivantes. Seule cette dernière forme d'une suite peut contenir des instructions composées ; ce qui suit n'est pas licite, principalement parce qu'il ne serait pas clair de savoir à quelle clause if se rapporterait une clause else placée en fin de ligne :

if test1: if test2: print(x)

Notez également que le point-virgule se lie plus étroitement que le deux-points dans ce contexte, de sorte que dans l'exemple suivant, soit tous les appels print() sont exécutés, soit aucun ne l'est :

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

En résumé :

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)* [";"]

Notez que ces instructions se terminent toujours par un lexème NEWLINE suivi éventuellement d'un DEDENT. Notez également que les clauses facultatives qui suivent commencent toujours par un mot-clé qui ne peut pas commencer une instruction. Ainsi, il n'y a pas d'ambiguïté (le problème du else dont on ne sait pas à quel if il est relié est résolu en Python en exigeant que des instructions if imbriquées soient indentées les unes par rapport aux autres).

L'agencement des règles de grammaire dans les sections qui suivent place chaque clause sur une ligne séparée pour plus de clarté.

8.1. L'instruction if

L'instruction if est utilisée pour exécuter des instructions en fonction d'une condition :

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

Elle sélectionne exactement une des suites en évaluant les expressions une par une jusqu'à ce qu'une soit vraie (voir la section Opérations booléennes pour la définition de vrai et faux) ; ensuite cette suite est exécutée (et aucune autre partie de l'instruction if n'est exécutée ou évaluée). Si toutes les expressions sont fausses, la suite de la clause else, si elle existe, est exécutée.

8.2. L'instruction while

L'instruction while est utilisée pour exécuter des instructions de manière répétée tant qu'une expression est vraie :

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

Python évalue l'expression de manière répétée et, tant qu'elle est vraie, exécute la première suite ; si l'expression est fausse (ce qui peut arriver même lors du premier test), la suite de la clause else, si elle existe, est exécutée et la boucle se termine.

Une instruction break exécutée dans la première suite termine la boucle sans exécuter la suite de la clause else. Une instruction continue exécutée dans la première suite saute le reste de la suite et retourne au test de l'expression.

8.3. L'instruction for

L'instruction for est utilisée pour itérer sur les éléments d'une séquence (par exemple une chaîne, un n-uplet ou une liste) ou un autre objet itérable :

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

La liste des expressions (expression_list dans la grammaire ci-dessus) est évaluée une seule fois ; elle doit produire un objet itérable. Un itérateur est créé pour le résultat de cette liste d'expression. La suite est ensuite exécutée une fois pour chaque élément fourni par l'itérateur, dans l'ordre renvoyé par l'itérateur. Chaque élément est assigné, à tour de rôle, à la liste cible (target_list dans la grammaire ci-dessus) en utilisant les règles des affectations (voir Les assignations), et ensuite la suite est exécutée. Lorsque les éléments sont épuisés (ce qui est immédiat lorsque la séquence est vide ou si un itérateur lève une exception StopIteration), la suite de la clause else, si elle existe, est exécutée et la boucle se termine.

Une instruction break exécutée dans la première suite termine la boucle sans exécuter la suite de la clause else. Une instruction continue exécutée dans la première suite saute le reste de la suite et continue avec l'élément suivant, ou avec la clause else s'il n'y a pas d'élément suivant.

La boucle for effectue des affectations aux variables de la liste cible, ce qui écrase toutes les affectations antérieures de ces variables, y compris celles effectuées dans la suite de la boucle 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

Les noms dans la liste cible ne sont pas supprimés lorsque la boucle est terminée mais, si la séquence est vide, ils n'auront pas du tout été assignés par la boucle. Petite astuce : la fonction native range() renvoie un itérateur sur des entiers approprié pour émuler la boucle classique en Pascal sur des entiers for i := a to b do ; par exemple, list(range(3)) renvoie la liste [0, 1, 2].

Note

Il y a une subtilité lorsque la séquence est modifiée par la boucle (cela ne peut se produire que pour les séquences mutables, c'est-à-dire les listes). Un compteur interne est utilisé pour savoir quel est l'élément suivant, et ce compteur est incrémenté à chaque itération. Lorsqu'il a atteint la longueur de la séquence, la boucle se termine. Cela signifie que si la suite supprime l'élément courant (ou un élément précédent) de la séquence, l'élément suivant est sauté (puisqu'il reçoit l'indice de l'élément courant qui a déjà été traité). De même, si la suite insère un élément avant l'élément courant, l'élément courant est traité une deuxième fois à la prochaine itération. Ceci peut conduire à de méchants bugs, que vous pouvez éviter en effectuant une copie temporaire d'une tranche ou de la séquence complète, par exemple :

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

8.4. L'instruction try

L'instruction try spécifie les gestionnaires d'exception ou le code de nettoyage pour un groupe d'instructions :

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 base class of the exception object, or a tuple containing an item that is the class or a base class of the exception object.

Si aucune clause except ne correspond à l'exception, la recherche d'un gestionnaire d'exception se poursuit dans le code englobant et dans la pile d'appels. 1

Si l'évaluation d'une expression dans l'en-tête d'une clause except lève une exception, la recherche initiale d'un gestionnaire est annulée et une recherche commence pour la nouvelle exception dans le code englobant et dans la pile d'appels (c'est traité comme si l'instruction try avait levé l'exception).

Lorsqu'une clause d'exception correspond, l'exception est assignée à la cible spécifiée après le mot-clé as dans cette clause except, si cette cible existe, et la suite de clause except est exécutée. Toutes les clauses except doivent avoir un bloc exécutable. Lorsque la fin de ce bloc est atteinte, l'exécution continue normalement après l'ensemble de l'instruction try (cela signifie que si deux gestionnaires imbriqués existent pour la même exception, et que l'exception se produit dans la clause try du gestionnaire interne, le gestionnaire externe ne gère pas l'exception).

Lorsqu'une exception a été assignée en utilisant as cible, elle est effacée à la fin de la clause except. C'est comme si :

except E as N:
    foo

avait été traduit en :

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

Cela veut dire que l'exception doit être assignée à un nom différent pour pouvoir s'y référer après la clause except. Les exceptions sont effacées parce qu'avec la trace de la pile d'appels qui leur est attachée, elles créent un cycle dans les pointeurs de références (avec le cadre de la pile), ce qui conduit à conserver tous les noms locaux de ce cadre en mémoire jusqu'au passage du ramasse-miettes.

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 Hiérarchie des types standards) 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)

La clause optionnelle else n'est exécutée que si l'exécution atteint la fin de la clause try, aucune exception n'a été levée, et aucun return, continue, ou break ont étés exécutés. Les exceptions dans la clause else ne sont pas gérées par les clauses except précédentes.

Si finally est présente, elle spécifie un gestionnaire de « nettoyage ». La clause try est exécutée, y compris les clauses except et else. Si une exception se produit dans l'une des clauses et n'est pas traitée, l'exception est temporairement sauvegardée. La clause finally est exécutée. S'il y a une exception sauvegardée, elle est levée à nouveau à la fin de la clause finally. Si la clause finally lève une autre exception, l'exception sauvegardée est définie comme le contexte de la nouvelle exception. Si la clause finally exécute une instruction return, break ou continue, l'exception sauvegardée est jetée :

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

L'information relative à l'exception n'est pas disponible pour le programme pendant l'exécution de la clause finally.

Lorsqu'une instruction return, break ou continue est exécutée dans la suite d'une instruction try d'une construction tryfinally, la clause finally est aussi exécutée « à la sortie ».

La valeur de retour d'une fonction est déterminée par la dernière instruction return exécutée. Puisque la clause finally s'exécute toujours, une instruction return exécutée dans le finally sera toujours la dernière clause exécutée :

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

Vous trouvez des informations supplémentaires relatives aux exceptions dans la section Exceptions et, dans la section L'instruction raise, des informations relatives à l'utilisation de l'instruction raise pour produire des exceptions.

Modifié dans la version 3.8: Avant Python 3.8, une instruction continue n'était pas licite dans une clause finally en raison d'un problème dans l'implémentation.

8.5. L'instruction with

L'instruction with est utilisée pour encapsuler l'exécution d'un bloc avec des méthodes définies par un gestionnaire de contexte (voir la section Gestionnaire de contexte With). Cela permet d'utiliser de manière simple le patron de conception classique tryexceptfinally.

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

L'exécution de l'instruction with avec un seul « élément » (item dans la grammaire) se déroule comme suit :

  1. L'expression de contexte (l'expression donnée dans le with_item) est évaluée pour obtenir un gestionnaire de contexte.

  2. La méthode __enter__() du gestionnaire de contexte est chargée pour une utilisation ultérieure.

  3. La méthode __exit__() du gestionnaire de contexte est chargée pour une utilisation ultérieure.

  4. La méthode __enter__() du gestionnaire de contexte est invoquée.

  5. Si une cible (target dans la grammaire ci-dessus) a été incluse dans l'instruction with, la valeur de retour de __enter__() lui est assignée.

    Note

    L'instruction with garantit que si la méthode __enter__() se termine sans erreur, alors la méthode __exit__() est toujours appelée. Ainsi, si une erreur se produit pendant l'affectation à la liste cible, elle est traitée de la même façon qu'une erreur se produisant dans la suite. Voir l'étape 6 ci-dessous.

  6. La suite est exécutée.

  7. La méthode __exit__() du gestionnaire de contexte est invoquée. Si une exception a causé la sortie de la suite, son type, sa valeur et sa pile d'appels sont passés en arguments à __exit__(). Sinon, trois arguments None sont fournis.

    Si l'on est sorti de la suite en raison d'une exception et que la valeur de retour de la méthode __exit__() était fausse, l'exception est levée à nouveau. Si la valeur de retour était vraie, l'exception est supprimée et l'exécution continue avec l'instruction qui suit l'instruction with.

    Si l'on est sorti de la suite pour une raison autre qu'une exception, la valeur de retour de __exit__() est ignorée et l'exécution se poursuit à l'endroit normal pour le type de sortie prise.

Le code suivant :

with EXPRESSION as TARGET:
    SUITE

est sémantiquement équivalent à :

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)

Avec plus d'un élément, les gestionnaires de contexte sont traités comme si plusieurs instructions with étaient imbriquées :

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

est sémantiquement équivalent à :

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

You can also write multi-item context managers in multiple lines if the items are surrounded by parentheses. For example:

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

Modifié dans la version 3.1: Prise en charge de multiples expressions de contexte.

Modifié dans la version 3.10: Support for using grouping parentheses to break the statement in multiple lines.

Voir aussi

PEP 343 — L'instruction « with »

La spécification, les motivations et des exemples de l'instruction with en Python.

8.6. The match statement

Nouveau dans la version 3.10.

The match statement is used for pattern matching. Syntax:

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

Note

This section uses single quotes to denote soft keywords.

Pattern matching takes a pattern as input (following case) and a subject value (following match). The pattern (which may contain subpatterns) is matched against the subject value. The outcomes are:

  • A match success or failure (also termed a pattern success or failure).

  • Possible binding of matched values to a name. The prerequisites for this are further discussed below.

The match and case keywords are soft keywords.

Voir aussi

  • PEP 634 -- Structural Pattern Matching: Specification

  • PEP 636 -- Structural Pattern Matching: Tutorial

8.6.1. Overview

Here's an overview of the logical flow of a match statement:

  1. The subject expression subject_expr is evaluated and a resulting subject value obtained. If the subject expression contains a comma, a tuple is constructed using the standard rules.

  2. Each pattern in a case_block is attempted to match with the subject value. The specific rules for success or failure are described below. The match attempt can also bind some or all of the standalone names within the pattern. The precise pattern binding rules vary per pattern type and are specified below. Name bindings made during a successful pattern match outlive the executed block and can be used after the match statement.

    Note

    During failed pattern matches, some subpatterns may succeed. Do not rely on bindings being made for a failed match. Conversely, do not rely on variables remaining unchanged after a failed match. The exact behavior is dependent on implementation and may vary. This is an intentional decision made to allow different implementations to add optimizations.

  3. If the pattern succeeds, the corresponding guard (if present) is evaluated. In this case all name bindings are guaranteed to have happened.

    • If the guard evaluates as truthy or missing, the block inside case_block is executed.

    • Otherwise, the next case_block is attempted as described above.

    • If there are no further case blocks, the match statement is completed.

Note

Users should generally never rely on a pattern being evaluated. Depending on implementation, the interpreter may cache values or use other optimizations which skip repeated evaluations.

A sample match statement:

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

In this case, if flag is a guard. Read more about that in the next section.

8.6.2. Guards

guard ::=  "if" named_expression

A guard (which is part of the case) must succeed for code inside the case block to execute. It takes the form: if followed by an expression.

The logical flow of a case block with a guard follows:

  1. Check that the pattern in the case block succeeded. If the pattern failed, the guard is not evaluated and the next case block is checked.

  2. If the pattern succeeded, evaluate the guard.

    • If the guard condition evaluates to "truthy", the case block is selected.

    • If the guard condition evaluates to "falsy", the case block is not selected.

    • If the guard raises an exception during evaluation, the exception bubbles up.

Guards are allowed to have side effects as they are expressions. Guard evaluation must proceed from the first to the last case block, one at a time, skipping case blocks whose pattern(s) don't all succeed. (I.e., guard evaluation must happen in order.) Guard evaluation must stop once a case block is selected.

8.6.3. Irrefutable Case Blocks

An irrefutable case block is a match-all case block. A match statement may have at most one irrefutable case block, and it must be last.

A case block is considered irrefutable if it has no guard and its pattern is irrefutable. A pattern is considered irrefutable if we can prove from its syntax alone that it will always succeed. Only the following patterns are irrefutable:

8.6.4. Patterns

Note

This section uses grammar notations beyond standard EBNF:

  • the notation SEP.RULE+ is shorthand for RULE (SEP RULE)*

  • the notation !RULE is shorthand for a negative lookahead assertion

The top-level syntax for patterns is:

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

The descriptions below will include a description "in simple terms" of what a pattern does for illustration purposes (credits to Raymond Hettinger for a document that inspired most of the descriptions). Note that these descriptions are purely for illustration purposes and may not reflect the underlying implementation. Furthermore, they do not cover all valid forms.

8.6.4.1. OR Patterns

An OR pattern is two or more patterns separated by vertical bars |. Syntax:

or_pattern ::=  "|".closed_pattern+

Only the final subpattern may be irrefutable, and each subpattern must bind the same set of names to avoid ambiguity.

An OR pattern matches each of its subpatterns in turn to the subject value, until one succeeds. The OR pattern is then considered successful. Otherwise, if none of the subpatterns succeed, the OR pattern fails.

In simple terms, P1 | P2 | ... will try to match P1, if it fails it will try to match P2, succeeding immediately if any succeeds, failing otherwise.

8.6.4.2. AS Patterns

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 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. Chaînes de caractères formatées littérales 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, guards, 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

Note

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

Note

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.

    Note

    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.

Note

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

    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:

    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 values 0.0 or False.

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.

Voir aussi

  • PEP 634 -- Structural Pattern Matching: Specification

  • PEP 636 -- Structural Pattern Matching: Tutorial

8.7. Définition de fonctions

Une définition de fonction définit un objet fonction allogène (voir la section Hiérarchie des types standards) :

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

Une définition de fonction est une instruction qui est exécutée. Son exécution lie le nom de la fonction, dans l'espace de nommage local courant, à un objet fonction (un objet qui encapsule le code exécutable de la fonction). Cet objet fonction contient une référence à l'espace des noms globaux courant comme espace des noms globaux à utiliser lorsque la fonction est appelée.

La définition de la fonction n'exécute pas le corps de la fonction ; elle n'est exécutée que lorsque la fonction est appelée. 4

Une définition de fonction peut être encapsulée dans une ou plusieurs expressions decorator ; les décorateurs sont évalués lorsque la fonction est définie, dans la portée qui contient la définition de fonction ; le résultat doit être un appelable, qui est invoqué avec l'objet fonction comme seul argument ; la valeur renvoyée est liée au nom de la fonction en lieu et place de l'objet fonction. Lorsqu'il y a plusieurs décorateurs, ils sont appliqués par imbrication ; par exemple, le code suivant :

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

est à peu près équivalent à :

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

sauf que la fonction originale n'est pas temporairement liée au nom func.

Modifié dans la version 3.9: les fonctions peuvent être décorées par toute expression d'affectation valide. Auparavant, la grammaire était beaucoup plus restrictive ; voir la PEP 614 pour obtenir les détails.

Lorsqu'un ou plusieurs paramètres sont de la forme parameter = expression, on dit que la fonction a des « valeurs de paramètres par défaut ». Pour un paramètre avec une valeur par défaut, l’argument correspondant peut être omis lors de l'appel, la valeur par défaut du paramètre est alors utilisée. Si un paramètre a une valeur par défaut, tous les paramètres suivants jusqu'à "*" doivent aussi avoir une valeur par défaut — ceci est une restriction syntaxique qui n'est pas exprimée dans la grammaire.

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

Modifié dans la version 3.8: The / function parameter syntax may be used to indicate positional-only parameters. See PEP 570 for details.

Les paramètres peuvent avoir une annotation sous la forme ": expression" après le nom du paramètre. Tout paramètre peut avoir une annotation, même ceux de la forme *identifier ou **identifier. Les fonctions peuvent avoir une annotation pour la valeur de retour, sous la forme "-> expression" après la liste des paramètres. Ces annotations peuvent prendre la forme de toute expression Python valide. Leur présence ne change pas la sémantique de la fonction. Les valeurs des annotations sont accessibles comme valeurs d'un dictionnaire dont les clés sont les noms des paramètres et défini comme attribut __annotations__ de l'objet fonction. Si annotations est importé de __future__, les annotations sont conservées sous la forme de chaînes de caractères, permettant leur évaluation différée. Autrement, elles sont interprétées en même temps que la déclaration des fonctions. Dans le premier cas, les annotations peuvent être interprétées dans un ordre différent de l'ordre dans lequel elles apparaissent dans le fichier.

Il est aussi possible de créer des fonctions anonymes (fonctions non liées à un nom), pour une utilisation immédiate dans des expressions. Utilisez alors des expressions lambda, décrites dans la section Expressions lambda. Notez qu'une expression lambda est simplement un raccourci pour définir une fonction simple ; une fonction définie par une instruction "def" peut être passée (en argument) ou assignée à un autre nom, tout comme une fonction définie par une expression lambda. La forme "def" est en fait plus puissante puisqu'elle permet l'exécution de plusieurs instructions et les annotations.

Note pour les programmeurs : les fonctions sont des objets de première classe. Une instruction "def" exécutée à l'intérieur d'une définition de fonction définit une fonction locale qui peut être renvoyée ou passée en tant qu'argument. Les variables libres utilisées dans la fonction imbriquée ont accès aux variables locales de la fonction contenant le "def". Voir la section Noms et liaisons pour plus de détails.

Voir aussi

PEP 3107 — Annotations de fonctions

La spécification originale pour les annotations de fonctions.

PEP 484 — Indications de types

Définition de la signification standard pour les annotations : indications de types.

PEP 526 — Syntaxe pour les annotations de variables

Capacité d'indiquer des types pour les déclarations de variables, y compris les variables de classes et les variables d'instances

PEP 563 — Évaluation différée des annotations

Gestion des références postérieures à l'intérieur des annotations en préservant les annotations sous forme de chaînes à l'exécution au lieu d'une évaluation directe.

8.8. Définition de classes

Une définition de classe définit un objet classe (voir la section Hiérarchie des types standards) :

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

Une définition de classe est une instruction qui est exécutée. La liste d'héritage (inheritance entre crochets dans la grammaire ci-dessus) donne habituellement une liste de classes de base (voir Métaclasses pour des utilisations plus avancées). Donc chaque élément de la liste doit pouvoir être évalué comme un objet classe qui autorise les sous-classes. Les classes sans liste d'héritage héritent, par défaut, de la classe de base object ; d'où :

class Foo:
    pass

est équivalente à :

class Foo(object):
    pass

La suite de la classe est ensuite exécutée dans un nouveau cadre d'exécution (voir Noms et liaisons), en utilisant un espace de nommage local nouvellement créé et l'espace de nommage global d'origine (habituellement, la suite contient principalement des définitions de fonctions). Lorsque la suite de la classe termine son exécution, son cadre d'exécution est abandonné mais son espace des noms locaux est sauvegardé 5. Un objet classe est alors créé en utilisant la liste d'héritage pour les classes de base et l'espace de nommage sauvegardé comme dictionnaire des attributs. Le nom de classe est lié à l'objet classe dans l'espace de nommage local original.

L'ordre dans lequel les attributs sont définis dans le corps de la classe est préservé dans le __dict__ de la nouvelle classe. Notez que ceci n'est fiable que juste après la création de la classe et seulement pour les classes qui ont été définies en utilisant la syntaxe de définition.

La création de classes peut être fortement personnalisée en utilisant les métaclasses.

Les classes peuvent aussi être décorées : comme pour les décorateurs de fonctions,:

@f1(arg)
@f2
class Foo: pass

est à peu près équivalent à :

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

Les règles d'évaluation pour les expressions de décorateurs sont les mêmes que pour les décorateurs de fonctions. Le résultat est alors lié au nom de la classe.

Modifié dans la version 3.9: les classes peuvent être décorées par toute expression d'affectation valide. Auparavant, la grammaire était beaucoup plus restrictive ; voir la PEP 614 pour obtenir les détails.

Note pour les programmeurs : les variables définies dans la définition de classe sont des attributs de classe ; elles sont partagées par les instances. Les attributs d'instance peuvent être définis dans une méthode en utilisant self.name = value. Les attributs de classe et d'instance sont accessibles par la notation "self.name", et un attribut d'instance masque un attribut de classe de même nom lorsqu'on y accède de cette façon. Les attributs de classe peuvent être utilisés comme valeurs par défaut pour les attributs d'instances, mais l'utilisation de valeurs mutables peut conduire à des résultats inattendus. Les descripteurs peuvent être utilisés pour créer des variables d'instances avec des détails d'implémentation différents.

Voir aussi

PEP 3115 — Métaclasses dans Python 3000

La proposition qui a modifié la déclaration de métaclasses à la syntaxe actuelle, et la sémantique pour la façon dont les classes avec métaclasses sont construites.

PEP 3129 — Décorateurs de classes

La proposition qui a ajouté des décorateurs de classe. Les décorateurs de fonction et de méthode ont été introduits dans PEP 318.

8.9. Coroutines

Nouveau dans la version 3.5.

8.9.1. Définition de fonctions coroutines

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.

Les fonctions définies avec la syntaxe async def sont toujours des fonctions coroutines, même si elles ne contiennent aucun mot-clé await ou async.

C'est une SyntaxError d'utiliser une expression yield from dans une coroutine.

Un exemple de fonction coroutine :

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

Modifié dans la version 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. L'instruction async for

async_for_stmt ::=  "async" for_stmt

Un itérable asynchrone fournit une méthode __aiter__ qui renvoie directement un itérateur asynchrone, celui-ci pouvant appeler du code asynchrone dans sa méthode __anext__.

L'instruction async for permet d'itérer facilement sur des itérables asynchrones.

Le code suivant :

async for TARGET in ITER:
    SUITE
else:
    SUITE2

est sémantiquement équivalent à :

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

Voir aussi __aiter__() et __anext__() pour plus de détails.

C'est une SyntaxError d'utiliser une instruction async for en dehors d'une fonction coroutine.

8.9.3. L'instruction async with

async_with_stmt ::=  "async" with_stmt

Un gestionnaire de contexte asynchrone est un gestionnaire de contexte qui est capable de suspendre l'exécution dans ses méthodes enter et exit.

Le code suivant :

async with EXPRESSION as TARGET:
    SUITE

est sémantiquement équivalent à :

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)

Voir aussi __aenter__() et __aexit__() pour plus de détails.

C'est une SyntaxError d'utiliser l'instruction async with en dehors d'une fonction coroutine.

Voir aussi

PEP 492 — Coroutines avec les syntaxes async et await

La proposition qui a fait que les coroutines soient un concept propre en Python, et a ajouté la syntaxe de prise en charge de celles-ci.

Notes

1

L'exception est propagée à la pile d'appels à moins qu'il n'y ait une clause finally qui lève une autre exception, ce qui entraîne la perte de l'ancienne exception. Cette nouvelle exception entraîne la perte pure et simple de l'ancienne.

2

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

The following standard library classes are sequences:

Note

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:

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

4

Une chaîne littérale apparaissant comme première instruction dans le corps de la fonction est transformée en attribut __doc__ de la fonction et donc en docstring de la fonction.

5

Une chaîne littérale apparaissant comme première instruction dans le corps de la classe est transformée en élément __doc__ de l'espace de nommage et donc en docstring de la classe.