blob: 989fb61f9f1f016b036679abfba824b12279410d [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001
2.. _expressions:
3
4***********
5Expressions
6***********
7
8.. index:: single: expression
9
10This chapter explains the meaning of the elements of expressions in Python.
11
12.. index:: single: BNF
13
14**Syntax Notes:** In this and the following chapters, extended BNF notation will
15be used to describe syntax, not lexical analysis. When (one alternative of) a
16syntax rule has the form
17
18.. productionlist:: *
19 name: `othername`
20
21.. index:: single: syntax
22
23and no semantics are given, the semantics of this form of ``name`` are the same
24as for ``othername``.
25
26
27.. _conversions:
28
29Arithmetic conversions
30======================
31
32.. index:: pair: arithmetic; conversion
33
34When a description of an arithmetic operator below uses the phrase "the numeric
35arguments are converted to a common type," the arguments are coerced using the
36coercion rules listed at :ref:`coercion-rules`. If both arguments are standard
37numeric types, the following coercions are applied:
38
39* If either argument is a complex number, the other is converted to complex;
40
41* otherwise, if either argument is a floating point number, the other is
42 converted to floating point;
43
44* otherwise, if either argument is a long integer, the other is converted to
45 long integer;
46
47* otherwise, both must be plain integers and no conversion is necessary.
48
49Some additional rules apply for certain operators (e.g., a string left argument
50to the '%' operator). Extensions can define their own coercions.
51
52
53.. _atoms:
54
55Atoms
56=====
57
58.. index:: single: atom
59
60Atoms are the most basic elements of expressions. The simplest atoms are
61identifiers or literals. Forms enclosed in reverse quotes or in parentheses,
62brackets or braces are also categorized syntactically as atoms. The syntax for
63atoms is:
64
65.. productionlist::
66 atom: `identifier` | `literal` | `enclosure`
67 enclosure: `parenth_form` | `list_display`
Alexandre Vassalottiee936a22010-01-09 23:35:54 +000068 : | `generator_expression` | `dict_display` | `set_display`
Georg Brandl8ec7f652007-08-15 14:28:01 +000069 : | `string_conversion` | `yield_atom`
70
71
72.. _atom-identifiers:
73
74Identifiers (Names)
75-------------------
76
77.. index::
78 single: name
79 single: identifier
80
81An identifier occurring as an atom is a name. See section :ref:`identifiers`
82for lexical definition and section :ref:`naming` for documentation of naming and
83binding.
84
85.. index:: exception: NameError
86
87When the name is bound to an object, evaluation of the atom yields that object.
88When a name is not bound, an attempt to evaluate it raises a :exc:`NameError`
89exception.
90
91.. index::
92 pair: name; mangling
93 pair: private; names
94
95**Private name mangling:** When an identifier that textually occurs in a class
96definition begins with two or more underscore characters and does not end in two
97or more underscores, it is considered a :dfn:`private name` of that class.
98Private names are transformed to a longer form before code is generated for
Georg Brandl7a48a8b2013-04-14 10:13:42 +020099them. The transformation inserts the class name, with leading underscores
100removed and a single underscore inserted, in front of the name. For example,
101the identifier ``__spam`` occurring in a class named ``Ham`` will be transformed
102to ``_Ham__spam``. This transformation is independent of the syntactical
103context in which the identifier is used. If the transformed name is extremely
104long (longer than 255 characters), implementation defined truncation may happen.
105If the class name consists only of underscores, no transformation is done.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000106
Georg Brandl8ec7f652007-08-15 14:28:01 +0000107
108
109.. _atom-literals:
110
111Literals
112--------
113
114.. index:: single: literal
115
116Python supports string literals and various numeric literals:
117
118.. productionlist::
119 literal: `stringliteral` | `integer` | `longinteger`
120 : | `floatnumber` | `imagnumber`
121
122Evaluation of a literal yields an object of the given type (string, integer,
123long integer, floating point number, complex number) with the given value. The
124value may be approximated in the case of floating point and imaginary (complex)
125literals. See section :ref:`literals` for details.
126
127.. index::
128 triple: immutable; data; type
129 pair: immutable; object
130
131All literals correspond to immutable data types, and hence the object's identity
132is less important than its value. Multiple evaluations of literals with the
133same value (either the same occurrence in the program text or a different
134occurrence) may obtain the same object or a different object with the same
135value.
136
137
138.. _parenthesized:
139
140Parenthesized forms
141-------------------
142
143.. index:: single: parenthesized form
144
145A parenthesized form is an optional expression list enclosed in parentheses:
146
147.. productionlist::
148 parenth_form: "(" [`expression_list`] ")"
149
150A parenthesized expression list yields whatever that expression list yields: if
151the list contains at least one comma, it yields a tuple; otherwise, it yields
152the single expression that makes up the expression list.
153
154.. index:: pair: empty; tuple
155
156An empty pair of parentheses yields an empty tuple object. Since tuples are
157immutable, the rules for literals apply (i.e., two occurrences of the empty
158tuple may or may not yield the same object).
159
160.. index::
161 single: comma
162 pair: tuple; display
163
164Note that tuples are not formed by the parentheses, but rather by use of the
165comma operator. The exception is the empty tuple, for which parentheses *are*
166required --- allowing unparenthesized "nothing" in expressions would cause
167ambiguities and allow common typos to pass uncaught.
168
169
170.. _lists:
171
172List displays
173-------------
174
175.. index::
176 pair: list; display
177 pair: list; comprehensions
178
179A list display is a possibly empty series of expressions enclosed in square
180brackets:
181
182.. productionlist::
183 list_display: "[" [`expression_list` | `list_comprehension`] "]"
184 list_comprehension: `expression` `list_for`
185 list_for: "for" `target_list` "in" `old_expression_list` [`list_iter`]
186 old_expression_list: `old_expression` [("," `old_expression`)+ [","]]
Georg Brandlcff39b02013-10-06 10:26:58 +0200187 old_expression: `or_test` | `old_lambda_expr`
Georg Brandl8ec7f652007-08-15 14:28:01 +0000188 list_iter: `list_for` | `list_if`
189 list_if: "if" `old_expression` [`list_iter`]
190
191.. index::
192 pair: list; comprehensions
193 object: list
194 pair: empty; list
195
196A list display yields a new list object. Its contents are specified by
197providing either a list of expressions or a list comprehension. When a
198comma-separated list of expressions is supplied, its elements are evaluated from
199left to right and placed into the list object in that order. When a list
200comprehension is supplied, it consists of a single expression followed by at
201least one :keyword:`for` clause and zero or more :keyword:`for` or :keyword:`if`
202clauses. In this case, the elements of the new list are those that would be
203produced by considering each of the :keyword:`for` or :keyword:`if` clauses a
204block, nesting from left to right, and evaluating the expression to produce a
205list element each time the innermost block is reached [#]_.
206
207
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000208.. _comprehensions:
209
210Displays for sets and dictionaries
211----------------------------------
212
213For constructing a set or a dictionary Python provides special syntax
214called "displays", each of them in two flavors:
215
216* either the container contents are listed explicitly, or
217
218* they are computed via a set of looping and filtering instructions, called a
219 :dfn:`comprehension`.
220
221Common syntax elements for comprehensions are:
222
223.. productionlist::
224 comprehension: `expression` `comp_for`
225 comp_for: "for" `target_list` "in" `or_test` [`comp_iter`]
226 comp_iter: `comp_for` | `comp_if`
227 comp_if: "if" `expression_nocond` [`comp_iter`]
228
229The comprehension consists of a single expression followed by at least one
230:keyword:`for` clause and zero or more :keyword:`for` or :keyword:`if` clauses.
231In this case, the elements of the new container are those that would be produced
232by considering each of the :keyword:`for` or :keyword:`if` clauses a block,
233nesting from left to right, and evaluating the expression to produce an element
234each time the innermost block is reached.
235
236Note that the comprehension is executed in a separate scope, so names assigned
237to in the target list don't "leak" in the enclosing scope.
238
239
Georg Brandl8ec7f652007-08-15 14:28:01 +0000240.. _genexpr:
241
242Generator expressions
243---------------------
244
245.. index:: pair: generator; expression
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000246 object: generator
Georg Brandl8ec7f652007-08-15 14:28:01 +0000247
248A generator expression is a compact generator notation in parentheses:
249
250.. productionlist::
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000251 generator_expression: "(" `expression` `comp_for` ")"
Georg Brandl8ec7f652007-08-15 14:28:01 +0000252
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000253A generator expression yields a new generator object. Its syntax is the same as
254for comprehensions, except that it is enclosed in parentheses instead of
255brackets or curly braces.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000256
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000257Variables used in the generator expression are evaluated lazily when the
258:meth:`__next__` method is called for generator object (in the same fashion as
259normal generators). However, the leftmost :keyword:`for` clause is immediately
260evaluated, so that an error produced by it can be seen before any other possible
Georg Brandl8e67ef52008-03-03 21:31:50 +0000261error in the code that handles the generator expression. Subsequent
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000262:keyword:`for` clauses cannot be evaluated immediately since they may depend on
263the previous :keyword:`for` loop. For example: ``(x*y for x in range(10) for y
264in bar(x))``.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000265
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000266The parentheses can be omitted on calls with only one argument. See section
Georg Brandl8ec7f652007-08-15 14:28:01 +0000267:ref:`calls` for the detail.
268
Georg Brandl8ec7f652007-08-15 14:28:01 +0000269.. _dict:
270
271Dictionary displays
272-------------------
273
274.. index:: pair: dictionary; display
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000275 key, datum, key/datum pair
276 object: dictionary
Georg Brandl8ec7f652007-08-15 14:28:01 +0000277
278A dictionary display is a possibly empty series of key/datum pairs enclosed in
279curly braces:
280
281.. productionlist::
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000282 dict_display: "{" [`key_datum_list` | `dict_comprehension`] "}"
Georg Brandl8ec7f652007-08-15 14:28:01 +0000283 key_datum_list: `key_datum` ("," `key_datum`)* [","]
284 key_datum: `expression` ":" `expression`
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000285 dict_comprehension: `expression` ":" `expression` `comp_for`
Georg Brandl8ec7f652007-08-15 14:28:01 +0000286
287A dictionary display yields a new dictionary object.
288
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000289If a comma-separated sequence of key/datum pairs is given, they are evaluated
290from left to right to define the entries of the dictionary: each key object is
291used as a key into the dictionary to store the corresponding datum. This means
292that you can specify the same key multiple times in the key/datum list, and the
293final dictionary's value for that key will be the last one given.
294
295A dict comprehension, in contrast to list and set comprehensions, needs two
296expressions separated with a colon followed by the usual "for" and "if" clauses.
297When the comprehension is run, the resulting key and value elements are inserted
298in the new dictionary in the order they are produced.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000299
300.. index:: pair: immutable; object
Alexandre Vassalottib6465472010-01-11 22:36:12 +0000301 hashable
Georg Brandl8ec7f652007-08-15 14:28:01 +0000302
303Restrictions on the types of the key values are listed earlier in section
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000304:ref:`types`. (To summarize, the key type should be :term:`hashable`, which excludes
Georg Brandl8ec7f652007-08-15 14:28:01 +0000305all mutable objects.) Clashes between duplicate keys are not detected; the last
306datum (textually rightmost in the display) stored for a given key value
307prevails.
308
309
Alexandre Vassalottiee936a22010-01-09 23:35:54 +0000310.. _set:
311
312Set displays
313------------
314
315.. index:: pair: set; display
316 object: set
317
318A set display is denoted by curly braces and distinguishable from dictionary
319displays by the lack of colons separating keys and values:
320
321.. productionlist::
322 set_display: "{" (`expression_list` | `comprehension`) "}"
323
324A set display yields a new mutable set object, the contents being specified by
325either a sequence of expressions or a comprehension. When a comma-separated
326list of expressions is supplied, its elements are evaluated from left to right
327and added to the set object. When a comprehension is supplied, the set is
328constructed from the elements resulting from the comprehension.
329
330An empty set cannot be constructed with ``{}``; this literal constructs an empty
331dictionary.
332
333
Georg Brandl8ec7f652007-08-15 14:28:01 +0000334.. _string-conversions:
335
336String conversions
337------------------
338
339.. index::
340 pair: string; conversion
341 pair: reverse; quotes
342 pair: backward; quotes
343 single: back-quotes
344
345A string conversion is an expression list enclosed in reverse (a.k.a. backward)
346quotes:
347
348.. productionlist::
Sandro Tosi73ce5e72011-10-31 19:19:26 +0100349 string_conversion: "`" `expression_list` "`"
Georg Brandl8ec7f652007-08-15 14:28:01 +0000350
351A string conversion evaluates the contained expression list and converts the
352resulting object into a string according to rules specific to its type.
353
354If the object is a string, a number, ``None``, or a tuple, list or dictionary
355containing only objects whose type is one of these, the resulting string is a
356valid Python expression which can be passed to the built-in function
357:func:`eval` to yield an expression with the same value (or an approximation, if
358floating point numbers are involved).
359
360(In particular, converting a string adds quotes around it and converts "funny"
361characters to escape sequences that are safe to print.)
362
363.. index:: object: recursive
364
365Recursive objects (for example, lists or dictionaries that contain a reference
366to themselves, directly or indirectly) use ``...`` to indicate a recursive
367reference, and the result cannot be passed to :func:`eval` to get an equal value
368(:exc:`SyntaxError` will be raised instead).
369
370.. index::
371 builtin: repr
372 builtin: str
373
374The built-in function :func:`repr` performs exactly the same conversion in its
375argument as enclosing it in parentheses and reverse quotes does. The built-in
376function :func:`str` performs a similar but more user-friendly conversion.
377
378
379.. _yieldexpr:
380
381Yield expressions
382-----------------
383
384.. index::
385 keyword: yield
386 pair: yield; expression
387 pair: generator; function
388
389.. productionlist::
390 yield_atom: "(" `yield_expression` ")"
391 yield_expression: "yield" [`expression_list`]
392
393.. versionadded:: 2.5
394
395The :keyword:`yield` expression is only used when defining a generator function,
396and can only be used in the body of a function definition. Using a
397:keyword:`yield` expression in a function definition is sufficient to cause that
398definition to create a generator function instead of a normal function.
399
400When a generator function is called, it returns an iterator known as a
401generator. That generator then controls the execution of a generator function.
402The execution starts when one of the generator's methods is called. At that
403time, the execution proceeds to the first :keyword:`yield` expression, where it
404is suspended again, returning the value of :token:`expression_list` to
405generator's caller. By suspended we mean that all local state is retained,
406including the current bindings of local variables, the instruction pointer, and
407the internal evaluation stack. When the execution is resumed by calling one of
408the generator's methods, the function can proceed exactly as if the
409:keyword:`yield` expression was just another external call. The value of the
410:keyword:`yield` expression after resuming depends on the method which resumed
411the execution.
412
413.. index:: single: coroutine
414
415All of this makes generator functions quite similar to coroutines; they yield
416multiple times, they have more than one entry point and their execution can be
417suspended. The only difference is that a generator function cannot control
418where should the execution continue after it yields; the control is always
Georg Brandl09302282010-10-06 09:32:48 +0000419transferred to the generator's caller.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000420
421.. index:: object: generator
422
R David Murray85307b42012-08-17 20:49:51 -0400423
424Generator-iterator methods
425^^^^^^^^^^^^^^^^^^^^^^^^^^
426
427This subsection describes the methods of a generator iterator. They can
428be used to control the execution of a generator function.
429
430Note that calling any of the generator methods below when the generator
431is already executing raises a :exc:`ValueError` exception.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000432
433.. index:: exception: StopIteration
434
435
436.. method:: generator.next()
437
438 Starts the execution of a generator function or resumes it at the last executed
439 :keyword:`yield` expression. When a generator function is resumed with a
Serhiy Storchakaea217722014-09-05 23:34:12 +0300440 :meth:`~generator.next` method, the current :keyword:`yield` expression
441 always evaluates to
Georg Brandl8ec7f652007-08-15 14:28:01 +0000442 :const:`None`. The execution then continues to the next :keyword:`yield`
443 expression, where the generator is suspended again, and the value of the
Serhiy Storchakaea217722014-09-05 23:34:12 +0300444 :token:`expression_list` is returned to :meth:`~generator.next`'s caller.
445 If the generator
Georg Brandl8ec7f652007-08-15 14:28:01 +0000446 exits without yielding another value, a :exc:`StopIteration` exception is
447 raised.
448
Georg Brandl8ec7f652007-08-15 14:28:01 +0000449.. method:: generator.send(value)
450
451 Resumes the execution and "sends" a value into the generator function. The
452 ``value`` argument becomes the result of the current :keyword:`yield`
453 expression. The :meth:`send` method returns the next value yielded by the
454 generator, or raises :exc:`StopIteration` if the generator exits without
455 yielding another value. When :meth:`send` is called to start the generator, it
456 must be called with :const:`None` as the argument, because there is no
Georg Brandl907a7202008-02-22 12:31:45 +0000457 :keyword:`yield` expression that could receive the value.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000458
459
460.. method:: generator.throw(type[, value[, traceback]])
461
462 Raises an exception of type ``type`` at the point where generator was paused,
463 and returns the next value yielded by the generator function. If the generator
464 exits without yielding another value, a :exc:`StopIteration` exception is
465 raised. If the generator function does not catch the passed-in exception, or
466 raises a different exception, then that exception propagates to the caller.
467
468.. index:: exception: GeneratorExit
469
470
471.. method:: generator.close()
472
473 Raises a :exc:`GeneratorExit` at the point where the generator function was
474 paused. If the generator function then raises :exc:`StopIteration` (by exiting
475 normally, or due to already being closed) or :exc:`GeneratorExit` (by not
476 catching the exception), close returns to its caller. If the generator yields a
477 value, a :exc:`RuntimeError` is raised. If the generator raises any other
478 exception, it is propagated to the caller. :meth:`close` does nothing if the
479 generator has already exited due to an exception or normal exit.
480
481Here is a simple example that demonstrates the behavior of generators and
482generator functions::
483
484 >>> def echo(value=None):
485 ... print "Execution starts when 'next()' is called for the first time."
486 ... try:
487 ... while True:
488 ... try:
489 ... value = (yield value)
Georg Brandl8ec7f652007-08-15 14:28:01 +0000490 ... except Exception, e:
491 ... value = e
492 ... finally:
493 ... print "Don't forget to clean up when 'close()' is called."
494 ...
495 >>> generator = echo(1)
496 >>> print generator.next()
497 Execution starts when 'next()' is called for the first time.
498 1
499 >>> print generator.next()
500 None
501 >>> print generator.send(2)
502 2
503 >>> generator.throw(TypeError, "spam")
504 TypeError('spam',)
505 >>> generator.close()
506 Don't forget to clean up when 'close()' is called.
507
508
509.. seealso::
510
Serhiy Storchaka838b1332016-03-31 15:31:04 +0300511 :pep:`342` - Coroutines via Enhanced Generators
Georg Brandl8ec7f652007-08-15 14:28:01 +0000512 The proposal to enhance the API and syntax of generators, making them usable as
513 simple coroutines.
514
515
516.. _primaries:
517
518Primaries
519=========
520
521.. index:: single: primary
522
523Primaries represent the most tightly bound operations of the language. Their
524syntax is:
525
526.. productionlist::
527 primary: `atom` | `attributeref` | `subscription` | `slicing` | `call`
528
529
530.. _attribute-references:
531
532Attribute references
533--------------------
534
535.. index:: pair: attribute; reference
536
537An attribute reference is a primary followed by a period and a name:
538
539.. productionlist::
540 attributeref: `primary` "." `identifier`
541
542.. index::
543 exception: AttributeError
544 object: module
545 object: list
546
547The primary must evaluate to an object of a type that supports attribute
548references, e.g., a module, list, or an instance. This object is then asked to
549produce the attribute whose name is the identifier. If this attribute is not
550available, the exception :exc:`AttributeError` is raised. Otherwise, the type
551and value of the object produced is determined by the object. Multiple
552evaluations of the same attribute reference may yield different objects.
553
554
555.. _subscriptions:
556
557Subscriptions
558-------------
559
560.. index:: single: subscription
561
562.. index::
563 object: sequence
564 object: mapping
565 object: string
566 object: tuple
567 object: list
568 object: dictionary
569 pair: sequence; item
570
571A subscription selects an item of a sequence (string, tuple or list) or mapping
572(dictionary) object:
573
574.. productionlist::
575 subscription: `primary` "[" `expression_list` "]"
576
577The primary must evaluate to an object of a sequence or mapping type.
578
579If the primary is a mapping, the expression list must evaluate to an object
580whose value is one of the keys of the mapping, and the subscription selects the
581value in the mapping that corresponds to that key. (The expression list is a
582tuple except if it has exactly one item.)
583
584If the primary is a sequence, the expression (list) must evaluate to a plain
585integer. If this value is negative, the length of the sequence is added to it
586(so that, e.g., ``x[-1]`` selects the last item of ``x``.) The resulting value
587must be a nonnegative integer less than the number of items in the sequence, and
588the subscription selects the item whose index is that value (counting from
589zero).
590
591.. index::
592 single: character
593 pair: string; item
594
595A string's items are characters. A character is not a separate data type but a
596string of exactly one character.
597
598
599.. _slicings:
600
601Slicings
602--------
603
604.. index::
605 single: slicing
606 single: slice
607
608.. index::
609 object: sequence
610 object: string
611 object: tuple
612 object: list
613
614A slicing selects a range of items in a sequence object (e.g., a string, tuple
615or list). Slicings may be used as expressions or as targets in assignment or
616:keyword:`del` statements. The syntax for a slicing:
617
618.. productionlist::
619 slicing: `simple_slicing` | `extended_slicing`
620 simple_slicing: `primary` "[" `short_slice` "]"
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000621 extended_slicing: `primary` "[" `slice_list` "]"
Georg Brandl8ec7f652007-08-15 14:28:01 +0000622 slice_list: `slice_item` ("," `slice_item`)* [","]
623 slice_item: `expression` | `proper_slice` | `ellipsis`
624 proper_slice: `short_slice` | `long_slice`
625 short_slice: [`lower_bound`] ":" [`upper_bound`]
626 long_slice: `short_slice` ":" [`stride`]
627 lower_bound: `expression`
628 upper_bound: `expression`
629 stride: `expression`
630 ellipsis: "..."
631
632.. index:: pair: extended; slicing
633
634There is ambiguity in the formal syntax here: anything that looks like an
635expression list also looks like a slice list, so any subscription can be
636interpreted as a slicing. Rather than further complicating the syntax, this is
637disambiguated by defining that in this case the interpretation as a subscription
638takes priority over the interpretation as a slicing (this is the case if the
639slice list contains no proper slice nor ellipses). Similarly, when the slice
640list has exactly one short slice and no trailing comma, the interpretation as a
641simple slicing takes priority over that as an extended slicing.
642
643The semantics for a simple slicing are as follows. The primary must evaluate to
644a sequence object. The lower and upper bound expressions, if present, must
645evaluate to plain integers; defaults are zero and the ``sys.maxint``,
646respectively. If either bound is negative, the sequence's length is added to
647it. The slicing now selects all items with index *k* such that ``i <= k < j``
648where *i* and *j* are the specified lower and upper bounds. This may be an
649empty sequence. It is not an error if *i* or *j* lie outside the range of valid
650indexes (such items don't exist so they aren't selected).
651
652.. index::
653 single: start (slice object attribute)
654 single: stop (slice object attribute)
655 single: step (slice object attribute)
656
657The semantics for an extended slicing are as follows. The primary must evaluate
658to a mapping object, and it is indexed with a key that is constructed from the
659slice list, as follows. If the slice list contains at least one comma, the key
660is a tuple containing the conversion of the slice items; otherwise, the
661conversion of the lone slice item is the key. The conversion of a slice item
662that is an expression is that expression. The conversion of an ellipsis slice
663item is the built-in ``Ellipsis`` object. The conversion of a proper slice is a
Serhiy Storchakaad16b722013-10-09 14:02:14 +0300664slice object (see section :ref:`types`) whose :attr:`~slice.start`,
665:attr:`~slice.stop` and :attr:`~slice.step` attributes are the values of the
666expressions given as lower bound, upper bound and stride, respectively,
667substituting ``None`` for missing expressions.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000668
669
Chris Jerdonekcf4710c2012-12-25 14:50:21 -0800670.. index::
671 object: callable
672 single: call
673 single: argument; call semantics
674
Georg Brandl8ec7f652007-08-15 14:28:01 +0000675.. _calls:
676
677Calls
678-----
679
Chris Jerdonekcf4710c2012-12-25 14:50:21 -0800680A call calls a callable object (e.g., a :term:`function`) with a possibly empty
681series of :term:`arguments <argument>`:
Georg Brandl8ec7f652007-08-15 14:28:01 +0000682
683.. productionlist::
684 call: `primary` "(" [`argument_list` [","]
685 : | `expression` `genexpr_for`] ")"
686 argument_list: `positional_arguments` ["," `keyword_arguments`]
Benjamin Peterson80f0ed52008-08-19 19:52:46 +0000687 : ["," "*" `expression`] ["," `keyword_arguments`]
688 : ["," "**" `expression`]
Georg Brandl8ec7f652007-08-15 14:28:01 +0000689 : | `keyword_arguments` ["," "*" `expression`]
Benjamin Peterson80f0ed52008-08-19 19:52:46 +0000690 : ["," "**" `expression`]
Benjamin Peterson13056bf2014-08-28 00:05:52 -0400691 : | "*" `expression` ["," `keyword_arguments`] ["," "**" `expression`]
Georg Brandl8ec7f652007-08-15 14:28:01 +0000692 : | "**" `expression`
693 positional_arguments: `expression` ("," `expression`)*
694 keyword_arguments: `keyword_item` ("," `keyword_item`)*
695 keyword_item: `identifier` "=" `expression`
696
697A trailing comma may be present after the positional and keyword arguments but
698does not affect the semantics.
699
Chris Jerdonekcf4710c2012-12-25 14:50:21 -0800700.. index::
701 single: parameter; call semantics
702
Georg Brandl8ec7f652007-08-15 14:28:01 +0000703The primary must evaluate to a callable object (user-defined functions, built-in
704functions, methods of built-in objects, class objects, methods of class
705instances, and certain class instances themselves are callable; extensions may
706define additional callable object types). All argument expressions are
707evaluated before the call is attempted. Please refer to section :ref:`function`
Chris Jerdonekcf4710c2012-12-25 14:50:21 -0800708for the syntax of formal :term:`parameter` lists.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000709
710If keyword arguments are present, they are first converted to positional
711arguments, as follows. First, a list of unfilled slots is created for the
712formal parameters. If there are N positional arguments, they are placed in the
713first N slots. Next, for each keyword argument, the identifier is used to
714determine the corresponding slot (if the identifier is the same as the first
715formal parameter name, the first slot is used, and so on). If the slot is
716already filled, a :exc:`TypeError` exception is raised. Otherwise, the value of
717the argument is placed in the slot, filling it (even if the expression is
718``None``, it fills the slot). When all arguments have been processed, the slots
719that are still unfilled are filled with the corresponding default value from the
720function definition. (Default values are calculated, once, when the function is
721defined; thus, a mutable object such as a list or dictionary used as default
722value will be shared by all calls that don't specify an argument value for the
723corresponding slot; this should usually be avoided.) If there are any unfilled
724slots for which no default value is specified, a :exc:`TypeError` exception is
725raised. Otherwise, the list of filled slots is used as the argument list for
726the call.
727
Georg Brandl6c14e582009-10-22 11:48:10 +0000728.. impl-detail::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000729
Georg Brandl6c14e582009-10-22 11:48:10 +0000730 An implementation may provide built-in functions whose positional parameters
731 do not have names, even if they are 'named' for the purpose of documentation,
732 and which therefore cannot be supplied by keyword. In CPython, this is the
Sandro Tosi98ed08f2012-01-14 16:42:02 +0100733 case for functions implemented in C that use :c:func:`PyArg_ParseTuple` to
Georg Brandl6c14e582009-10-22 11:48:10 +0000734 parse their arguments.
Georg Brandlf8770fb2008-04-27 09:39:59 +0000735
Georg Brandl8ec7f652007-08-15 14:28:01 +0000736If there are more positional arguments than there are formal parameter slots, a
737:exc:`TypeError` exception is raised, unless a formal parameter using the syntax
738``*identifier`` is present; in this case, that formal parameter receives a tuple
739containing the excess positional arguments (or an empty tuple if there were no
740excess positional arguments).
741
742If any keyword argument does not correspond to a formal parameter name, a
743:exc:`TypeError` exception is raised, unless a formal parameter using the syntax
744``**identifier`` is present; in this case, that formal parameter receives a
745dictionary containing the excess keyword arguments (using the keywords as keys
746and the argument values as corresponding values), or a (new) empty dictionary if
747there were no excess keyword arguments.
748
Eli Bendersky2cdf3832011-07-29 14:45:08 +0300749.. index::
750 single: *; in function calls
751
Georg Brandl8ec7f652007-08-15 14:28:01 +0000752If the syntax ``*expression`` appears in the function call, ``expression`` must
Eli Bendersky2cdf3832011-07-29 14:45:08 +0300753evaluate to an iterable. Elements from this iterable are treated as if they
754were additional positional arguments; if there are positional arguments
Ezio Melotti4cfdb072011-07-30 21:31:22 +0300755*x1*, ..., *xN*, and ``expression`` evaluates to a sequence *y1*, ..., *yM*, this
Eli Bendersky2cdf3832011-07-29 14:45:08 +0300756is equivalent to a call with M+N positional arguments *x1*, ..., *xN*, *y1*,
757..., *yM*.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000758
Benjamin Peterson80f0ed52008-08-19 19:52:46 +0000759A consequence of this is that although the ``*expression`` syntax may appear
760*after* some keyword arguments, it is processed *before* the keyword arguments
Georg Brandl8ec7f652007-08-15 14:28:01 +0000761(and the ``**expression`` argument, if any -- see below). So::
762
763 >>> def f(a, b):
Serhiy Storchaka12d547a2016-05-10 13:45:32 +0300764 ... print a, b
Georg Brandl8ec7f652007-08-15 14:28:01 +0000765 ...
766 >>> f(b=1, *(2,))
767 2 1
768 >>> f(a=1, *(2,))
769 Traceback (most recent call last):
770 File "<stdin>", line 1, in ?
771 TypeError: f() got multiple values for keyword argument 'a'
772 >>> f(1, *(2,))
773 1 2
774
775It is unusual for both keyword arguments and the ``*expression`` syntax to be
776used in the same call, so in practice this confusion does not arise.
777
Eli Bendersky2cdf3832011-07-29 14:45:08 +0300778.. index::
779 single: **; in function calls
780
Georg Brandl8ec7f652007-08-15 14:28:01 +0000781If the syntax ``**expression`` appears in the function call, ``expression`` must
782evaluate to a mapping, the contents of which are treated as additional keyword
783arguments. In the case of a keyword appearing in both ``expression`` and as an
784explicit keyword argument, a :exc:`TypeError` exception is raised.
785
786Formal parameters using the syntax ``*identifier`` or ``**identifier`` cannot be
787used as positional argument slots or as keyword argument names. Formal
788parameters using the syntax ``(sublist)`` cannot be used as keyword argument
789names; the outermost sublist corresponds to a single unnamed argument slot, and
790the argument value is assigned to the sublist using the usual tuple assignment
791rules after all other parameter processing is done.
792
793A call always returns some value, possibly ``None``, unless it raises an
794exception. How this value is computed depends on the type of the callable
795object.
796
797If it is---
798
799a user-defined function:
800 .. index::
801 pair: function; call
802 triple: user-defined; function; call
803 object: user-defined function
804 object: function
805
806 The code block for the function is executed, passing it the argument list. The
807 first thing the code block will do is bind the formal parameters to the
808 arguments; this is described in section :ref:`function`. When the code block
809 executes a :keyword:`return` statement, this specifies the return value of the
810 function call.
811
812a built-in function or method:
813 .. index::
814 pair: function; call
815 pair: built-in function; call
816 pair: method; call
817 pair: built-in method; call
818 object: built-in method
819 object: built-in function
820 object: method
821 object: function
822
823 The result is up to the interpreter; see :ref:`built-in-funcs` for the
824 descriptions of built-in functions and methods.
825
826a class object:
827 .. index::
828 object: class
829 pair: class object; call
830
831 A new instance of that class is returned.
832
833a class instance method:
834 .. index::
835 object: class instance
836 object: instance
837 pair: class instance; call
838
839 The corresponding user-defined function is called, with an argument list that is
840 one longer than the argument list of the call: the instance becomes the first
841 argument.
842
843a class instance:
844 .. index::
845 pair: instance; call
846 single: __call__() (object method)
847
848 The class must define a :meth:`__call__` method; the effect is then the same as
849 if that method was called.
850
851
852.. _power:
853
854The power operator
855==================
856
857The power operator binds more tightly than unary operators on its left; it binds
858less tightly than unary operators on its right. The syntax is:
859
860.. productionlist::
861 power: `primary` ["**" `u_expr`]
862
863Thus, in an unparenthesized sequence of power and unary operators, the operators
864are evaluated from right to left (this does not constrain the evaluation order
Georg Brandlff457b12007-08-21 06:07:08 +0000865for the operands): ``-1**2`` results in ``-1``.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000866
867The power operator has the same semantics as the built-in :func:`pow` function,
868when called with two arguments: it yields its left argument raised to the power
869of its right argument. The numeric arguments are first converted to a common
870type. The result type is that of the arguments after coercion.
871
872With mixed operand types, the coercion rules for binary arithmetic operators
873apply. For int and long int operands, the result has the same type as the
874operands (after coercion) unless the second argument is negative; in that case,
875all arguments are converted to float and a float result is delivered. For
876example, ``10**2`` returns ``100``, but ``10**-2`` returns ``0.01``. (This last
877feature was added in Python 2.2. In Python 2.1 and before, if both arguments
878were of integer types and the second argument was negative, an exception was
879raised).
880
881Raising ``0.0`` to a negative power results in a :exc:`ZeroDivisionError`.
Jeffrey Yasskin9871d8f2008-01-05 08:47:13 +0000882Raising a negative number to a fractional power results in a :exc:`ValueError`.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000883
884
885.. _unary:
886
Georg Brandle7cb1ce2009-02-19 08:30:06 +0000887Unary arithmetic and bitwise operations
888=======================================
Georg Brandl8ec7f652007-08-15 14:28:01 +0000889
890.. index::
891 triple: unary; arithmetic; operation
Georg Brandlf725b952008-01-05 19:44:22 +0000892 triple: unary; bitwise; operation
Georg Brandl8ec7f652007-08-15 14:28:01 +0000893
Georg Brandle7cb1ce2009-02-19 08:30:06 +0000894All unary arithmetic and bitwise operations have the same priority:
Georg Brandl8ec7f652007-08-15 14:28:01 +0000895
896.. productionlist::
897 u_expr: `power` | "-" `u_expr` | "+" `u_expr` | "~" `u_expr`
898
899.. index::
900 single: negation
901 single: minus
902
903The unary ``-`` (minus) operator yields the negation of its numeric argument.
904
905.. index:: single: plus
906
907The unary ``+`` (plus) operator yields its numeric argument unchanged.
908
909.. index:: single: inversion
910
Georg Brandlf725b952008-01-05 19:44:22 +0000911The unary ``~`` (invert) operator yields the bitwise inversion of its plain or
912long integer argument. The bitwise inversion of ``x`` is defined as
Georg Brandl8ec7f652007-08-15 14:28:01 +0000913``-(x+1)``. It only applies to integral numbers.
914
915.. index:: exception: TypeError
916
917In all three cases, if the argument does not have the proper type, a
918:exc:`TypeError` exception is raised.
919
920
921.. _binary:
922
923Binary arithmetic operations
924============================
925
926.. index:: triple: binary; arithmetic; operation
927
928The binary arithmetic operations have the conventional priority levels. Note
929that some of these operations also apply to certain non-numeric types. Apart
930from the power operator, there are only two levels, one for multiplicative
931operators and one for additive operators:
932
933.. productionlist::
934 m_expr: `u_expr` | `m_expr` "*" `u_expr` | `m_expr` "//" `u_expr` | `m_expr` "/" `u_expr`
935 : | `m_expr` "%" `u_expr`
936 a_expr: `m_expr` | `a_expr` "+" `m_expr` | `a_expr` "-" `m_expr`
937
938.. index:: single: multiplication
939
940The ``*`` (multiplication) operator yields the product of its arguments. The
941arguments must either both be numbers, or one argument must be an integer (plain
942or long) and the other must be a sequence. In the former case, the numbers are
943converted to a common type and then multiplied together. In the latter case,
944sequence repetition is performed; a negative repetition factor yields an empty
945sequence.
946
947.. index::
948 exception: ZeroDivisionError
949 single: division
950
951The ``/`` (division) and ``//`` (floor division) operators yield the quotient of
952their arguments. The numeric arguments are first converted to a common type.
953Plain or long integer division yields an integer of the same type; the result is
954that of mathematical division with the 'floor' function applied to the result.
955Division by zero raises the :exc:`ZeroDivisionError` exception.
956
957.. index:: single: modulo
958
959The ``%`` (modulo) operator yields the remainder from the division of the first
960argument by the second. The numeric arguments are first converted to a common
961type. A zero right argument raises the :exc:`ZeroDivisionError` exception. The
962arguments may be floating point numbers, e.g., ``3.14%0.7`` equals ``0.34``
963(since ``3.14`` equals ``4*0.7 + 0.34``.) The modulo operator always yields a
964result with the same sign as its second operand (or zero); the absolute value of
965the result is strictly smaller than the absolute value of the second operand
966[#]_.
967
968The integer division and modulo operators are connected by the following
969identity: ``x == (x/y)*y + (x%y)``. Integer division and modulo are also
970connected with the built-in function :func:`divmod`: ``divmod(x, y) == (x/y,
971x%y)``. These identities don't hold for floating point numbers; there similar
972identities hold approximately where ``x/y`` is replaced by ``floor(x/y)`` or
973``floor(x/y) - 1`` [#]_.
974
975In addition to performing the modulo operation on numbers, the ``%`` operator is
976also overloaded by string and unicode objects to perform string formatting (also
977known as interpolation). The syntax for string formatting is described in the
978Python Library Reference, section :ref:`string-formatting`.
979
980.. deprecated:: 2.3
981 The floor division operator, the modulo operator, and the :func:`divmod`
982 function are no longer defined for complex numbers. Instead, convert to a
983 floating point number using the :func:`abs` function if appropriate.
984
985.. index:: single: addition
986
987The ``+`` (addition) operator yields the sum of its arguments. The arguments
988must either both be numbers or both sequences of the same type. In the former
989case, the numbers are converted to a common type and then added together. In
990the latter case, the sequences are concatenated.
991
992.. index:: single: subtraction
993
994The ``-`` (subtraction) operator yields the difference of its arguments. The
995numeric arguments are first converted to a common type.
996
997
998.. _shifting:
999
1000Shifting operations
1001===================
1002
1003.. index:: pair: shifting; operation
1004
1005The shifting operations have lower priority than the arithmetic operations:
1006
1007.. productionlist::
1008 shift_expr: `a_expr` | `shift_expr` ( "<<" | ">>" ) `a_expr`
1009
1010These operators accept plain or long integers as arguments. The arguments are
1011converted to a common type. They shift the first argument to the left or right
1012by the number of bits given by the second argument.
1013
1014.. index:: exception: ValueError
1015
Georg Brandle9135ba2008-05-11 10:55:59 +00001016A right shift by *n* bits is defined as division by ``pow(2, n)``. A left shift
1017by *n* bits is defined as multiplication with ``pow(2, n)``. Negative shift
1018counts raise a :exc:`ValueError` exception.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001019
Georg Brandlfb120442010-04-06 20:27:59 +00001020.. note::
1021
1022 In the current implementation, the right-hand operand is required
Mark Dickinsona5db4312010-04-06 18:20:11 +00001023 to be at most :attr:`sys.maxsize`. If the right-hand operand is larger than
1024 :attr:`sys.maxsize` an :exc:`OverflowError` exception is raised.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001025
1026.. _bitwise:
1027
Georg Brandlf725b952008-01-05 19:44:22 +00001028Binary bitwise operations
1029=========================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001030
Georg Brandlf725b952008-01-05 19:44:22 +00001031.. index:: triple: binary; bitwise; operation
Georg Brandl8ec7f652007-08-15 14:28:01 +00001032
1033Each of the three bitwise operations has a different priority level:
1034
1035.. productionlist::
1036 and_expr: `shift_expr` | `and_expr` "&" `shift_expr`
1037 xor_expr: `and_expr` | `xor_expr` "^" `and_expr`
1038 or_expr: `xor_expr` | `or_expr` "|" `xor_expr`
1039
Georg Brandlf725b952008-01-05 19:44:22 +00001040.. index:: pair: bitwise; and
Georg Brandl8ec7f652007-08-15 14:28:01 +00001041
1042The ``&`` operator yields the bitwise AND of its arguments, which must be plain
1043or long integers. The arguments are converted to a common type.
1044
1045.. index::
Georg Brandlf725b952008-01-05 19:44:22 +00001046 pair: bitwise; xor
Georg Brandl8ec7f652007-08-15 14:28:01 +00001047 pair: exclusive; or
1048
1049The ``^`` operator yields the bitwise XOR (exclusive OR) of its arguments, which
1050must be plain or long integers. The arguments are converted to a common type.
1051
1052.. index::
Georg Brandlf725b952008-01-05 19:44:22 +00001053 pair: bitwise; or
Georg Brandl8ec7f652007-08-15 14:28:01 +00001054 pair: inclusive; or
1055
1056The ``|`` operator yields the bitwise (inclusive) OR of its arguments, which
1057must be plain or long integers. The arguments are converted to a common type.
1058
1059
1060.. _comparisons:
1061
1062Comparisons
1063===========
1064
1065.. index:: single: comparison
1066
1067.. index:: pair: C; language
1068
1069Unlike C, all comparison operations in Python have the same priority, which is
1070lower than that of any arithmetic, shifting or bitwise operation. Also unlike
1071C, expressions like ``a < b < c`` have the interpretation that is conventional
1072in mathematics:
1073
1074.. productionlist::
1075 comparison: `or_expr` ( `comp_operator` `or_expr` )*
1076 comp_operator: "<" | ">" | "==" | ">=" | "<=" | "<>" | "!="
1077 : | "is" ["not"] | ["not"] "in"
1078
1079Comparisons yield boolean values: ``True`` or ``False``.
1080
1081.. index:: pair: chaining; comparisons
1082
1083Comparisons can be chained arbitrarily, e.g., ``x < y <= z`` is equivalent to
1084``x < y and y <= z``, except that ``y`` is evaluated only once (but in both
1085cases ``z`` is not evaluated at all when ``x < y`` is found to be false).
1086
Georg Brandl32008322007-08-21 06:12:19 +00001087Formally, if *a*, *b*, *c*, ..., *y*, *z* are expressions and *op1*, *op2*, ...,
1088*opN* are comparison operators, then ``a op1 b op2 c ... y opN z`` is equivalent
1089to ``a op1 b and b op2 c and ... y opN z``, except that each expression is
1090evaluated at most once.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001091
Georg Brandl32008322007-08-21 06:12:19 +00001092Note that ``a op1 b op2 c`` doesn't imply any kind of comparison between *a* and
Georg Brandl8ec7f652007-08-15 14:28:01 +00001093*c*, so that, e.g., ``x < y > z`` is perfectly legal (though perhaps not
1094pretty).
1095
1096The forms ``<>`` and ``!=`` are equivalent; for consistency with C, ``!=`` is
1097preferred; where ``!=`` is mentioned below ``<>`` is also accepted. The ``<>``
1098spelling is considered obsolescent.
1099
Martin Panter60a1b352017-01-21 05:14:56 +00001100Value comparisons
1101-----------------
1102
Georg Brandl8ec7f652007-08-15 14:28:01 +00001103The operators ``<``, ``>``, ``==``, ``>=``, ``<=``, and ``!=`` compare the
Martin Panter60a1b352017-01-21 05:14:56 +00001104values of two objects. The objects do not need to have the same type.
1105
1106Chapter :ref:`objects` states that objects have a value (in addition to type
1107and identity). The value of an object is a rather abstract notion in Python:
1108For example, there is no canonical access method for an object's value. Also,
1109there is no requirement that the value of an object should be constructed in a
1110particular way, e.g. comprised of all its data attributes. Comparison operators
1111implement a particular notion of what the value of an object is. One can think
1112of them as defining the value of an object indirectly, by means of their
1113comparison implementation.
1114
1115Types can customize their comparison behavior by implementing
1116a :meth:`__cmp__` method or
1117:dfn:`rich comparison methods` like :meth:`__lt__`, described in
1118:ref:`customization`.
1119
1120The default behavior for equality comparison (``==`` and ``!=``) is based on
1121the identity of the objects. Hence, equality comparison of instances with the
1122same identity results in equality, and equality comparison of instances with
1123different identities results in inequality. A motivation for this default
1124behavior is the desire that all objects should be reflexive (i.e. ``x is y``
1125implies ``x == y``).
1126
1127The default order comparison (``<``, ``>``, ``<=``, and ``>=``) gives a
1128consistent but arbitrary order.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001129
1130(This unusual definition of comparison was used to simplify the definition of
1131operations like sorting and the :keyword:`in` and :keyword:`not in` operators.
1132In the future, the comparison rules for objects of different types are likely to
1133change.)
1134
Martin Panter60a1b352017-01-21 05:14:56 +00001135The behavior of the default equality comparison, that instances with different
1136identities are always unequal, may be in contrast to what types will need that
1137have a sensible definition of object value and value-based equality. Such
1138types will need to customize their comparison behavior, and in fact, a number
1139of built-in types have done that.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001140
Martin Panter60a1b352017-01-21 05:14:56 +00001141The following list describes the comparison behavior of the most important
1142built-in types.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001143
Martin Panter60a1b352017-01-21 05:14:56 +00001144* Numbers of built-in numeric types (:ref:`typesnumeric`) and of the standard
1145 library types :class:`fractions.Fraction` and :class:`decimal.Decimal` can be
1146 compared within and across their types, with the restriction that complex
1147 numbers do not support order comparison. Within the limits of the types
1148 involved, they compare mathematically (algorithmically) correct without loss
1149 of precision.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001150
Martin Panter60a1b352017-01-21 05:14:56 +00001151* Strings (instances of :class:`str` or :class:`unicode`)
1152 compare lexicographically using the numeric equivalents (the
1153 result of the built-in function :func:`ord`) of their characters. [#]_
1154 When comparing an 8-bit string and a Unicode string, the 8-bit string
1155 is converted to Unicode. If the conversion fails, the strings
1156 are considered unequal.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001157
Martin Panter60a1b352017-01-21 05:14:56 +00001158* Instances of :class:`tuple` or :class:`list` can be compared only
1159 within each of their types. Equality comparison across these types
1160 results in unequality, and ordering comparison across these types
1161 gives an arbitrary order.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001162
Martin Panter60a1b352017-01-21 05:14:56 +00001163 These sequences compare lexicographically using comparison of corresponding
1164 elements, whereby reflexivity of the elements is enforced.
1165
1166 In enforcing reflexivity of elements, the comparison of collections assumes
1167 that for a collection element ``x``, ``x == x`` is always true. Based on
1168 that assumption, element identity is compared first, and element comparison
1169 is performed only for distinct elements. This approach yields the same
1170 result as a strict element comparison would, if the compared elements are
1171 reflexive. For non-reflexive elements, the result is different than for
1172 strict element comparison.
1173
1174 Lexicographical comparison between built-in collections works as follows:
1175
1176 - For two collections to compare equal, they must be of the same type, have
1177 the same length, and each pair of corresponding elements must compare
1178 equal (for example, ``[1,2] == (1,2)`` is false because the type is not the
1179 same).
1180
1181 - Collections are ordered the same as their
1182 first unequal elements (for example, ``cmp([1,2,x], [1,2,y])`` returns the
1183 same as ``cmp(x,y)``). If a corresponding element does not exist, the
1184 shorter collection is ordered first (for example, ``[1,2] < [1,2,3]`` is
1185 true).
1186
1187* Mappings (instances of :class:`dict`) compare equal if and only if they have
1188 equal `(key, value)` pairs. Equality comparison of the keys and elements
1189 enforces reflexivity.
1190
1191 Outcomes other than equality are resolved
Georg Brandl8ec7f652007-08-15 14:28:01 +00001192 consistently, but are not otherwise defined. [#]_
1193
Georg Brandld7d4fd72009-07-26 14:37:28 +00001194* Most other objects of built-in types compare unequal unless they are the same
Georg Brandl8ec7f652007-08-15 14:28:01 +00001195 object; the choice whether one object is considered smaller or larger than
1196 another one is made arbitrarily but consistently within one execution of a
1197 program.
1198
Martin Panter60a1b352017-01-21 05:14:56 +00001199User-defined classes that customize their comparison behavior should follow
1200some consistency rules, if possible:
1201
1202* Equality comparison should be reflexive.
1203 In other words, identical objects should compare equal:
1204
1205 ``x is y`` implies ``x == y``
1206
1207* Comparison should be symmetric.
1208 In other words, the following expressions should have the same result:
1209
1210 ``x == y`` and ``y == x``
1211
1212 ``x != y`` and ``y != x``
1213
1214 ``x < y`` and ``y > x``
1215
1216 ``x <= y`` and ``y >= x``
1217
1218* Comparison should be transitive.
1219 The following (non-exhaustive) examples illustrate that:
1220
1221 ``x > y and y > z`` implies ``x > z``
1222
1223 ``x < y and y <= z`` implies ``x < z``
1224
1225* Inverse comparison should result in the boolean negation.
1226 In other words, the following expressions should have the same result:
1227
1228 ``x == y`` and ``not x != y``
1229
1230 ``x < y`` and ``not x >= y`` (for total ordering)
1231
1232 ``x > y`` and ``not x <= y`` (for total ordering)
1233
1234 The last two expressions apply to totally ordered collections (e.g. to
1235 sequences, but not to sets or mappings). See also the
1236 :func:`~functools.total_ordering` decorator.
1237
1238* The :func:`hash` result should be consistent with equality.
1239 Objects that are equal should either have the same hash value,
1240 or be marked as unhashable.
1241
1242Python does not enforce these consistency rules.
1243
1244
1245.. _in:
1246.. _not in:
Georg Brandl2eee1d42009-10-22 15:00:06 +00001247.. _membership-test-details:
1248
Martin Panter60a1b352017-01-21 05:14:56 +00001249Membership test operations
1250--------------------------
1251
Georg Brandl489343e2008-03-28 12:24:51 +00001252The operators :keyword:`in` and :keyword:`not in` test for collection
1253membership. ``x in s`` evaluates to true if *x* is a member of the collection
1254*s*, and false otherwise. ``x not in s`` returns the negation of ``x in s``.
1255The collection membership test has traditionally been bound to sequences; an
1256object is a member of a collection if the collection is a sequence and contains
1257an element equal to that object. However, it make sense for many other object
1258types to support membership tests without being a sequence. In particular,
1259dictionaries (for keys) and sets support membership testing.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001260
1261For the list and tuple types, ``x in y`` is true if and only if there exists an
Raymond Hettinger167c81d2016-04-26 00:59:16 -07001262index *i* such that either ``x is y[i]`` or ``x == y[i]`` is true.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001263
1264For the Unicode and string types, ``x in y`` is true if and only if *x* is a
1265substring of *y*. An equivalent test is ``y.find(x) != -1``. Note, *x* and *y*
1266need not be the same type; consequently, ``u'ab' in 'abc'`` will return
1267``True``. Empty strings are always considered to be a substring of any other
1268string, so ``"" in "abc"`` will return ``True``.
1269
1270.. versionchanged:: 2.3
1271 Previously, *x* was required to be a string of length ``1``.
1272
1273For user-defined classes which define the :meth:`__contains__` method, ``x in
1274y`` is true if and only if ``y.__contains__(x)`` is true.
1275
Georg Brandl2eee1d42009-10-22 15:00:06 +00001276For user-defined classes which do not define :meth:`__contains__` but do define
1277:meth:`__iter__`, ``x in y`` is true if some value ``z`` with ``x == z`` is
1278produced while iterating over ``y``. If an exception is raised during the
1279iteration, it is as if :keyword:`in` raised that exception.
1280
1281Lastly, the old-style iteration protocol is tried: if a class defines
Georg Brandl8ec7f652007-08-15 14:28:01 +00001282:meth:`__getitem__`, ``x in y`` is true if and only if there is a non-negative
1283integer index *i* such that ``x == y[i]``, and all lower integer indices do not
1284raise :exc:`IndexError` exception. (If any other exception is raised, it is as
1285if :keyword:`in` raised that exception).
1286
1287.. index::
1288 operator: in
1289 operator: not in
1290 pair: membership; test
1291 object: sequence
1292
1293The operator :keyword:`not in` is defined to have the inverse true value of
1294:keyword:`in`.
1295
1296.. index::
1297 operator: is
1298 operator: is not
1299 pair: identity; test
1300
Martin Panter60a1b352017-01-21 05:14:56 +00001301
1302.. _is:
1303.. _is not:
1304
1305Identity comparisons
1306--------------------
1307
Georg Brandl8ec7f652007-08-15 14:28:01 +00001308The operators :keyword:`is` and :keyword:`is not` test for object identity: ``x
1309is y`` is true if and only if *x* and *y* are the same object. ``x is not y``
Georg Brandl3214a012008-07-01 20:50:02 +00001310yields the inverse truth value. [#]_
Georg Brandl8ec7f652007-08-15 14:28:01 +00001311
1312
1313.. _booleans:
Georg Brandlb19be572007-12-29 10:57:00 +00001314.. _and:
1315.. _or:
1316.. _not:
Georg Brandl8ec7f652007-08-15 14:28:01 +00001317
1318Boolean operations
1319==================
1320
1321.. index::
1322 pair: Conditional; expression
1323 pair: Boolean; operation
1324
Georg Brandl8ec7f652007-08-15 14:28:01 +00001325.. productionlist::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001326 or_test: `and_test` | `or_test` "or" `and_test`
1327 and_test: `not_test` | `and_test` "and" `not_test`
1328 not_test: `comparison` | "not" `not_test`
1329
1330In the context of Boolean operations, and also when expressions are used by
1331control flow statements, the following values are interpreted as false:
1332``False``, ``None``, numeric zero of all types, and empty strings and containers
1333(including strings, tuples, lists, dictionaries, sets and frozensets). All
Benjamin Petersonfe7c26d2008-09-23 13:32:46 +00001334other values are interpreted as true. (See the :meth:`~object.__nonzero__`
1335special method for a way to change this.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001336
1337.. index:: operator: not
1338
1339The operator :keyword:`not` yields ``True`` if its argument is false, ``False``
1340otherwise.
1341
Georg Brandl8ec7f652007-08-15 14:28:01 +00001342.. index:: operator: and
1343
1344The expression ``x and y`` first evaluates *x*; if *x* is false, its value is
1345returned; otherwise, *y* is evaluated and the resulting value is returned.
1346
1347.. index:: operator: or
1348
1349The expression ``x or y`` first evaluates *x*; if *x* is true, its value is
1350returned; otherwise, *y* is evaluated and the resulting value is returned.
1351
1352(Note that neither :keyword:`and` nor :keyword:`or` restrict the value and type
1353they return to ``False`` and ``True``, but rather return the last evaluated
1354argument. This is sometimes useful, e.g., if ``s`` is a string that should be
1355replaced by a default value if it is empty, the expression ``s or 'foo'`` yields
1356the desired value. Because :keyword:`not` has to invent a value anyway, it does
1357not bother to return a value of the same type as its argument, so e.g., ``not
1358'foo'`` yields ``False``, not ``''``.)
1359
1360
Georg Brandl38c72032010-03-07 21:12:28 +00001361Conditional Expressions
1362=======================
1363
1364.. versionadded:: 2.5
1365
1366.. index::
1367 pair: conditional; expression
1368 pair: ternary; operator
1369
1370.. productionlist::
1371 conditional_expression: `or_test` ["if" `or_test` "else" `expression`]
Georg Brandlcff39b02013-10-06 10:26:58 +02001372 expression: `conditional_expression` | `lambda_expr`
Georg Brandl38c72032010-03-07 21:12:28 +00001373
1374Conditional expressions (sometimes called a "ternary operator") have the lowest
1375priority of all Python operations.
1376
Georg Brandld22557c2010-03-08 16:28:40 +00001377The expression ``x if C else y`` first evaluates the condition, *C* (*not* *x*);
Georg Brandl38c72032010-03-07 21:12:28 +00001378if *C* is true, *x* is evaluated and its value is returned; otherwise, *y* is
1379evaluated and its value is returned.
1380
1381See :pep:`308` for more details about conditional expressions.
1382
1383
Georg Brandl8ec7f652007-08-15 14:28:01 +00001384.. _lambdas:
Georg Brandl5623e502009-04-10 08:16:47 +00001385.. _lambda:
Georg Brandl8ec7f652007-08-15 14:28:01 +00001386
1387Lambdas
1388=======
1389
1390.. index::
1391 pair: lambda; expression
Georg Brandl8ec7f652007-08-15 14:28:01 +00001392 pair: anonymous; function
1393
1394.. productionlist::
Georg Brandlcff39b02013-10-06 10:26:58 +02001395 lambda_expr: "lambda" [`parameter_list`]: `expression`
1396 old_lambda_expr: "lambda" [`parameter_list`]: `old_expression`
Georg Brandl8ec7f652007-08-15 14:28:01 +00001397
Georg Brandlcff39b02013-10-06 10:26:58 +02001398Lambda expressions (sometimes called lambda forms) have the same syntactic position as
Georg Brandl8ec7f652007-08-15 14:28:01 +00001399expressions. They are a shorthand to create anonymous functions; the expression
1400``lambda arguments: expression`` yields a function object. The unnamed object
1401behaves like a function object defined with ::
1402
1403 def name(arguments):
1404 return expression
1405
1406See section :ref:`function` for the syntax of parameter lists. Note that
Georg Brandlcff39b02013-10-06 10:26:58 +02001407functions created with lambda expressions cannot contain statements.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001408
Georg Brandl8ec7f652007-08-15 14:28:01 +00001409
1410.. _exprlists:
1411
1412Expression lists
1413================
1414
1415.. index:: pair: expression; list
1416
1417.. productionlist::
1418 expression_list: `expression` ( "," `expression` )* [","]
1419
1420.. index:: object: tuple
1421
1422An expression list containing at least one comma yields a tuple. The length of
1423the tuple is the number of expressions in the list. The expressions are
1424evaluated from left to right.
1425
1426.. index:: pair: trailing; comma
1427
1428The trailing comma is required only to create a single tuple (a.k.a. a
1429*singleton*); it is optional in all other cases. A single expression without a
1430trailing comma doesn't create a tuple, but rather yields the value of that
1431expression. (To create an empty tuple, use an empty pair of parentheses:
1432``()``.)
1433
1434
1435.. _evalorder:
1436
1437Evaluation order
1438================
1439
1440.. index:: pair: evaluation; order
1441
1442Python evaluates expressions from left to right. Notice that while evaluating an
1443assignment, the right-hand side is evaluated before the left-hand side.
1444
1445In the following lines, expressions will be evaluated in the arithmetic order of
1446their suffixes::
1447
1448 expr1, expr2, expr3, expr4
1449 (expr1, expr2, expr3, expr4)
1450 {expr1: expr2, expr3: expr4}
1451 expr1 + expr2 * (expr3 - expr4)
Georg Brandl463f39d2008-08-08 06:42:20 +00001452 expr1(expr2, expr3, *expr4, **expr5)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001453 expr3, expr4 = expr1, expr2
1454
1455
1456.. _operator-summary:
1457
Ezio Melotti4268b3a2012-12-25 15:45:15 +02001458Operator precedence
1459===================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001460
1461.. index:: pair: operator; precedence
1462
1463The following table summarizes the operator precedences in Python, from lowest
1464precedence (least binding) to highest precedence (most binding). Operators in
1465the same box have the same precedence. Unless the syntax is explicitly given,
1466operators are binary. Operators in the same box group left to right (except for
1467comparisons, including tests, which all have the same precedence and chain from
1468left to right --- see section :ref:`comparisons` --- and exponentiation, which
1469groups from right to left).
1470
1471+-----------------------------------------------+-------------------------------------+
1472| Operator | Description |
1473+===============================================+=====================================+
1474| :keyword:`lambda` | Lambda expression |
1475+-----------------------------------------------+-------------------------------------+
Georg Brandl38c72032010-03-07 21:12:28 +00001476| :keyword:`if` -- :keyword:`else` | Conditional expression |
1477+-----------------------------------------------+-------------------------------------+
Georg Brandl8ec7f652007-08-15 14:28:01 +00001478| :keyword:`or` | Boolean OR |
1479+-----------------------------------------------+-------------------------------------+
1480| :keyword:`and` | Boolean AND |
1481+-----------------------------------------------+-------------------------------------+
Ezio Melotti4268b3a2012-12-25 15:45:15 +02001482| :keyword:`not` ``x`` | Boolean NOT |
Georg Brandl8ec7f652007-08-15 14:28:01 +00001483+-----------------------------------------------+-------------------------------------+
Ezio Melotti4268b3a2012-12-25 15:45:15 +02001484| :keyword:`in`, :keyword:`not in`, | Comparisons, including membership |
Georg Brandl44ea77b2013-03-28 13:28:44 +01001485| :keyword:`is`, :keyword:`is not`, ``<``, | tests and identity tests |
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001486| ``<=``, ``>``, ``>=``, ``<>``, ``!=``, ``==`` | |
Georg Brandl8ec7f652007-08-15 14:28:01 +00001487+-----------------------------------------------+-------------------------------------+
1488| ``|`` | Bitwise OR |
1489+-----------------------------------------------+-------------------------------------+
1490| ``^`` | Bitwise XOR |
1491+-----------------------------------------------+-------------------------------------+
1492| ``&`` | Bitwise AND |
1493+-----------------------------------------------+-------------------------------------+
1494| ``<<``, ``>>`` | Shifts |
1495+-----------------------------------------------+-------------------------------------+
1496| ``+``, ``-`` | Addition and subtraction |
1497+-----------------------------------------------+-------------------------------------+
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001498| ``*``, ``/``, ``//``, ``%`` | Multiplication, division, remainder |
Georg Brandl21946af2010-10-06 09:28:45 +00001499| | [#]_ |
Georg Brandl8ec7f652007-08-15 14:28:01 +00001500+-----------------------------------------------+-------------------------------------+
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001501| ``+x``, ``-x``, ``~x`` | Positive, negative, bitwise NOT |
Georg Brandl8ec7f652007-08-15 14:28:01 +00001502+-----------------------------------------------+-------------------------------------+
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001503| ``**`` | Exponentiation [#]_ |
Georg Brandl8ec7f652007-08-15 14:28:01 +00001504+-----------------------------------------------+-------------------------------------+
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001505| ``x[index]``, ``x[index:index]``, | Subscription, slicing, |
1506| ``x(arguments...)``, ``x.attribute`` | call, attribute reference |
Georg Brandl8ec7f652007-08-15 14:28:01 +00001507+-----------------------------------------------+-------------------------------------+
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001508| ``(expressions...)``, | Binding or tuple display, |
1509| ``[expressions...]``, | list display, |
Ezio Melotti4268b3a2012-12-25 15:45:15 +02001510| ``{key: value...}``, | dictionary display, |
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001511| ```expressions...``` | string conversion |
Georg Brandl8ec7f652007-08-15 14:28:01 +00001512+-----------------------------------------------+-------------------------------------+
1513
1514.. rubric:: Footnotes
1515
Martin v. Löwis0b667312008-05-23 19:33:13 +00001516.. [#] In Python 2.3 and later releases, a list comprehension "leaks" the control
Georg Brandlc62ef8b2009-01-03 20:55:06 +00001517 variables of each ``for`` it contains into the containing scope. However, this
Ezio Melotti510ff542012-05-03 19:21:40 +03001518 behavior is deprecated, and relying on it will not work in Python 3.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001519
1520.. [#] While ``abs(x%y) < abs(y)`` is true mathematically, for floats it may not be
1521 true numerically due to roundoff. For example, and assuming a platform on which
1522 a Python float is an IEEE 754 double-precision number, in order that ``-1e-100 %
1523 1e100`` have the same sign as ``1e100``, the computed result is ``-1e-100 +
Georg Brandl52f83952011-02-25 10:39:23 +00001524 1e100``, which is numerically exactly equal to ``1e100``. The function
1525 :func:`math.fmod` returns a result whose sign matches the sign of the
Georg Brandl8ec7f652007-08-15 14:28:01 +00001526 first argument instead, and so returns ``-1e-100`` in this case. Which approach
1527 is more appropriate depends on the application.
1528
1529.. [#] If x is very close to an exact integer multiple of y, it's possible for
1530 ``floor(x/y)`` to be one larger than ``(x-x%y)/y`` due to rounding. In such
1531 cases, Python returns the latter result, in order to preserve that
1532 ``divmod(x,y)[0] * y + x % y`` be very close to ``x``.
1533
Martin Panter60a1b352017-01-21 05:14:56 +00001534.. [#] The Unicode standard distinguishes between :dfn:`code points`
1535 (e.g. U+0041) and :dfn:`abstract characters` (e.g. "LATIN CAPITAL LETTER A").
1536 While most abstract characters in Unicode are only represented using one
1537 code point, there is a number of abstract characters that can in addition be
1538 represented using a sequence of more than one code point. For example, the
1539 abstract character "LATIN CAPITAL LETTER C WITH CEDILLA" can be represented
1540 as a single :dfn:`precomposed character` at code position U+00C7, or as a
1541 sequence of a :dfn:`base character` at code position U+0043 (LATIN CAPITAL
1542 LETTER C), followed by a :dfn:`combining character` at code position U+0327
1543 (COMBINING CEDILLA).
Mark Summerfield216ad332007-08-16 10:09:22 +00001544
Martin Panter60a1b352017-01-21 05:14:56 +00001545 The comparison operators on unicode strings compare at the level of Unicode code
1546 points. This may be counter-intuitive to humans. For example,
1547 ``u"\u00C7" == u"\u0043\u0327"`` is ``False``, even though both strings
1548 represent the same abstract character "LATIN CAPITAL LETTER C WITH CEDILLA".
1549
1550 To compare strings at the level of abstract characters (that is, in a way
1551 intuitive to humans), use :func:`unicodedata.normalize`.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001552
1553.. [#] Earlier versions of Python used lexicographic comparison of the sorted (key,
1554 value) lists, but this was very expensive for the common case of comparing for
1555 equality. An even earlier version of Python compared dictionaries by identity
1556 only, but this caused surprises because people expected to be able to test a
1557 dictionary for emptiness by comparing it to ``{}``.
1558
Georg Brandlc62ef8b2009-01-03 20:55:06 +00001559.. [#] Due to automatic garbage-collection, free lists, and the dynamic nature of
Georg Brandl3214a012008-07-01 20:50:02 +00001560 descriptors, you may notice seemingly unusual behaviour in certain uses of
1561 the :keyword:`is` operator, like those involving comparisons between instance
1562 methods, or constants. Check their documentation for more info.
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001563
Georg Brandl52f83952011-02-25 10:39:23 +00001564.. [#] The ``%`` operator is also used for string formatting; the same
1565 precedence applies.
Georg Brandl21946af2010-10-06 09:28:45 +00001566
Georg Brandle7cb1ce2009-02-19 08:30:06 +00001567.. [#] The power operator ``**`` binds less tightly than an arithmetic or
1568 bitwise unary operator on its right, that is, ``2**-1`` is ``0.5``.