blob: df3dbf4977e01eb55a426376c7f2a4935cff4baa [file] [log] [blame]
Georg Brandld7413152009-10-11 21:25:26 +00001======================
2Design and History FAQ
3======================
4
Andrés Delfino38cf49b2018-06-23 15:27:16 -03005.. only:: html
6
7 .. contents::
8
9
Georg Brandld7413152009-10-11 21:25:26 +000010Why does Python use indentation for grouping of statements?
11-----------------------------------------------------------
12
13Guido van Rossum believes that using indentation for grouping is extremely
14elegant and contributes a lot to the clarity of the average Python program.
Georg Brandl99de4882009-12-20 14:24:06 +000015Most people learn to love this feature after a while.
Georg Brandld7413152009-10-11 21:25:26 +000016
17Since there are no begin/end brackets there cannot be a disagreement between
18grouping perceived by the parser and the human reader. Occasionally C
19programmers will encounter a fragment of code like this::
20
21 if (x <= y)
22 x++;
23 y--;
24 z++;
25
26Only the ``x++`` statement is executed if the condition is true, but the
Aerosd0068002019-06-21 00:43:07 -040027indentation leads many to believe otherwise. Even experienced C programmers will
28sometimes stare at it a long time wondering as to why ``y`` is being decremented even
Georg Brandld7413152009-10-11 21:25:26 +000029for ``x > y``.
30
31Because there are no begin/end brackets, Python is much less prone to
32coding-style conflicts. In C there are many different ways to place the braces.
Aerosd0068002019-06-21 00:43:07 -040033After becoming used to reading and writing code using a particular style,
34it is normal to feel somewhat uneasy when reading (or being required to write)
35in a different one.
36
Georg Brandld7413152009-10-11 21:25:26 +000037
Georg Brandl6faee4e2010-09-21 14:48:28 +000038Many coding styles place begin/end brackets on a line by themselves. This makes
Georg Brandld7413152009-10-11 21:25:26 +000039programs considerably longer and wastes valuable screen space, making it harder
40to get a good overview of a program. Ideally, a function should fit on one
Serhiy Storchakac7b1a0b2016-11-26 13:43:28 +020041screen (say, 20--30 lines). 20 lines of Python can do a lot more work than 20
Georg Brandld7413152009-10-11 21:25:26 +000042lines of C. This is not solely due to the lack of begin/end brackets -- the
43lack of declarations and the high-level data types are also responsible -- but
44the indentation-based syntax certainly helps.
45
46
47Why am I getting strange results with simple arithmetic operations?
48-------------------------------------------------------------------
49
50See the next question.
51
52
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010053Why are floating-point calculations so inaccurate?
Georg Brandld7413152009-10-11 21:25:26 +000054--------------------------------------------------
55
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010056Users are often surprised by results like this::
Georg Brandld7413152009-10-11 21:25:26 +000057
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010058 >>> 1.2 - 1.0
Georg Brandl9205e9e2014-10-06 17:51:09 +020059 0.19999999999999996
Georg Brandld7413152009-10-11 21:25:26 +000060
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010061and think it is a bug in Python. It's not. This has little to do with Python,
62and much more to do with how the underlying platform handles floating-point
63numbers.
Georg Brandld7413152009-10-11 21:25:26 +000064
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010065The :class:`float` type in CPython uses a C ``double`` for storage. A
66:class:`float` object's value is stored in binary floating-point with a fixed
67precision (typically 53 bits) and Python uses C operations, which in turn rely
68on the hardware implementation in the processor, to perform floating-point
69operations. This means that as far as floating-point operations are concerned,
70Python behaves like many popular languages including C and Java.
Georg Brandld7413152009-10-11 21:25:26 +000071
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010072Many numbers that can be written easily in decimal notation cannot be expressed
73exactly in binary floating-point. For example, after::
Georg Brandld7413152009-10-11 21:25:26 +000074
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010075 >>> x = 1.2
Georg Brandld7413152009-10-11 21:25:26 +000076
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010077the value stored for ``x`` is a (very good) approximation to the decimal value
78``1.2``, but is not exactly equal to it. On a typical machine, the actual
79stored value is::
Georg Brandld7413152009-10-11 21:25:26 +000080
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010081 1.0011001100110011001100110011001100110011001100110011 (binary)
Georg Brandld7413152009-10-11 21:25:26 +000082
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010083which is exactly::
Georg Brandld7413152009-10-11 21:25:26 +000084
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010085 1.1999999999999999555910790149937383830547332763671875 (decimal)
Georg Brandld7413152009-10-11 21:25:26 +000086
Serhiy Storchakac7b1a0b2016-11-26 13:43:28 +020087The typical precision of 53 bits provides Python floats with 15--16
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010088decimal digits of accuracy.
Georg Brandld7413152009-10-11 21:25:26 +000089
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010090For a fuller explanation, please see the :ref:`floating point arithmetic
91<tut-fp-issues>` chapter in the Python tutorial.
Georg Brandld7413152009-10-11 21:25:26 +000092
93
94Why are Python strings immutable?
95---------------------------------
96
97There are several advantages.
98
99One is performance: knowing that a string is immutable means we can allocate
100space for it at creation time, and the storage requirements are fixed and
101unchanging. This is also one of the reasons for the distinction between tuples
102and lists.
103
104Another advantage is that strings in Python are considered as "elemental" as
105numbers. No amount of activity will change the value 8 to anything else, and in
106Python, no amount of activity will change the string "eight" to anything else.
107
108
109.. _why-self:
110
111Why must 'self' be used explicitly in method definitions and calls?
112-------------------------------------------------------------------
113
114The idea was borrowed from Modula-3. It turns out to be very useful, for a
115variety of reasons.
116
117First, it's more obvious that you are using a method or instance attribute
118instead of a local variable. Reading ``self.x`` or ``self.meth()`` makes it
119absolutely clear that an instance variable or method is used even if you don't
120know the class definition by heart. In C++, you can sort of tell by the lack of
121a local variable declaration (assuming globals are rare or easily recognizable)
122-- but in Python, there are no local variable declarations, so you'd have to
123look up the class definition to be sure. Some C++ and Java coding standards
124call for instance attributes to have an ``m_`` prefix, so this explicitness is
125still useful in those languages, too.
126
127Second, it means that no special syntax is necessary if you want to explicitly
128reference or call the method from a particular class. In C++, if you want to
129use a method from a base class which is overridden in a derived class, you have
Georg Brandl99de4882009-12-20 14:24:06 +0000130to use the ``::`` operator -- in Python you can write
131``baseclass.methodname(self, <argument list>)``. This is particularly useful
132for :meth:`__init__` methods, and in general in cases where a derived class
133method wants to extend the base class method of the same name and thus has to
134call the base class method somehow.
Georg Brandld7413152009-10-11 21:25:26 +0000135
136Finally, for instance variables it solves a syntactic problem with assignment:
137since local variables in Python are (by definition!) those variables to which a
Georg Brandl99de4882009-12-20 14:24:06 +0000138value is assigned in a function body (and that aren't explicitly declared
139global), there has to be some way to tell the interpreter that an assignment was
140meant to assign to an instance variable instead of to a local variable, and it
141should preferably be syntactic (for efficiency reasons). C++ does this through
Georg Brandld7413152009-10-11 21:25:26 +0000142declarations, but Python doesn't have declarations and it would be a pity having
Georg Brandl99de4882009-12-20 14:24:06 +0000143to introduce them just for this purpose. Using the explicit ``self.var`` solves
Georg Brandld7413152009-10-11 21:25:26 +0000144this nicely. Similarly, for using instance variables, having to write
Georg Brandl99de4882009-12-20 14:24:06 +0000145``self.var`` means that references to unqualified names inside a method don't
146have to search the instance's directories. To put it another way, local
147variables and instance variables live in two different namespaces, and you need
148to tell Python which namespace to use.
Georg Brandld7413152009-10-11 21:25:26 +0000149
150
Adorilson Bezerra5807efd2020-02-03 14:11:19 -0300151.. _why-can-t-i-use-an-assignment-in-an-expression:
152
Georg Brandld7413152009-10-11 21:25:26 +0000153Why can't I use an assignment in an expression?
154-----------------------------------------------
155
Emily Morehouse6357c952019-09-11 15:37:12 +0100156Starting in Python 3.8, you can!
Georg Brandld7413152009-10-11 21:25:26 +0000157
Emily Morehouse6357c952019-09-11 15:37:12 +0100158Assignment expressions using the walrus operator `:=` assign a variable in an
159expression::
Georg Brandld7413152009-10-11 21:25:26 +0000160
Emily Morehouse6357c952019-09-11 15:37:12 +0100161 while chunk := fp.read(200):
162 print(chunk)
Georg Brandld7413152009-10-11 21:25:26 +0000163
Emily Morehouse6357c952019-09-11 15:37:12 +0100164See :pep:`572` for more information.
Georg Brandld7413152009-10-11 21:25:26 +0000165
166
167
168Why does Python use methods for some functionality (e.g. list.index()) but functions for other (e.g. len(list))?
169----------------------------------------------------------------------------------------------------------------
170
INADA Naokic48e26d2018-07-31 14:49:22 +0900171As Guido said:
Georg Brandld7413152009-10-11 21:25:26 +0000172
INADA Naokic48e26d2018-07-31 14:49:22 +0900173 (a) For some operations, prefix notation just reads better than
174 postfix -- prefix (and infix!) operations have a long tradition in
175 mathematics which likes notations where the visuals help the
176 mathematician thinking about a problem. Compare the easy with which we
177 rewrite a formula like x*(a+b) into x*a + x*b to the clumsiness of
178 doing the same thing using a raw OO notation.
Georg Brandld7413152009-10-11 21:25:26 +0000179
INADA Naokic48e26d2018-07-31 14:49:22 +0900180 (b) When I read code that says len(x) I *know* that it is asking for
181 the length of something. This tells me two things: the result is an
182 integer, and the argument is some kind of container. To the contrary,
183 when I read x.len(), I have to already know that x is some kind of
184 container implementing an interface or inheriting from a class that
185 has a standard len(). Witness the confusion we occasionally have when
186 a class that is not implementing a mapping has a get() or keys()
187 method, or something that isn't a file has a write() method.
Georg Brandld7413152009-10-11 21:25:26 +0000188
INADA Naokic48e26d2018-07-31 14:49:22 +0900189 -- https://mail.python.org/pipermail/python-3000/2006-November/004643.html
Georg Brandld7413152009-10-11 21:25:26 +0000190
191
192Why is join() a string method instead of a list or tuple method?
193----------------------------------------------------------------
194
195Strings became much more like other standard types starting in Python 1.6, when
196methods were added which give the same functionality that has always been
197available using the functions of the string module. Most of these new methods
198have been widely accepted, but the one which appears to make some programmers
199feel uncomfortable is::
200
201 ", ".join(['1', '2', '4', '8', '16'])
202
203which gives the result::
204
205 "1, 2, 4, 8, 16"
206
207There are two common arguments against this usage.
208
209The first runs along the lines of: "It looks really ugly using a method of a
210string literal (string constant)", to which the answer is that it might, but a
211string literal is just a fixed value. If the methods are to be allowed on names
212bound to strings there is no logical reason to make them unavailable on
213literals.
214
215The second objection is typically cast as: "I am really telling a sequence to
216join its members together with a string constant". Sadly, you aren't. For some
217reason there seems to be much less difficulty with having :meth:`~str.split` as
218a string method, since in that case it is easy to see that ::
219
220 "1, 2, 4, 8, 16".split(", ")
221
222is an instruction to a string literal to return the substrings delimited by the
Georg Brandl99de4882009-12-20 14:24:06 +0000223given separator (or, by default, arbitrary runs of white space).
Georg Brandld7413152009-10-11 21:25:26 +0000224
225:meth:`~str.join` is a string method because in using it you are telling the
226separator string to iterate over a sequence of strings and insert itself between
227adjacent elements. This method can be used with any argument which obeys the
228rules for sequence objects, including any new classes you might define yourself.
Georg Brandl99de4882009-12-20 14:24:06 +0000229Similar methods exist for bytes and bytearray objects.
Georg Brandld7413152009-10-11 21:25:26 +0000230
231
232How fast are exceptions?
233------------------------
234
Georg Brandl12c3cd72012-03-17 16:58:05 +0100235A try/except block is extremely efficient if no exceptions are raised. Actually
236catching an exception is expensive. In versions of Python prior to 2.0 it was
237common to use this idiom::
Georg Brandld7413152009-10-11 21:25:26 +0000238
239 try:
Georg Brandl99de4882009-12-20 14:24:06 +0000240 value = mydict[key]
Georg Brandld7413152009-10-11 21:25:26 +0000241 except KeyError:
Georg Brandl99de4882009-12-20 14:24:06 +0000242 mydict[key] = getvalue(key)
243 value = mydict[key]
Georg Brandld7413152009-10-11 21:25:26 +0000244
245This only made sense when you expected the dict to have the key almost all the
246time. If that wasn't the case, you coded it like this::
247
Georg Brandl12c3cd72012-03-17 16:58:05 +0100248 if key in mydict:
Georg Brandl99de4882009-12-20 14:24:06 +0000249 value = mydict[key]
Georg Brandld7413152009-10-11 21:25:26 +0000250 else:
Georg Brandl12c3cd72012-03-17 16:58:05 +0100251 value = mydict[key] = getvalue(key)
Georg Brandld7413152009-10-11 21:25:26 +0000252
Georg Brandlbfe95ac2009-12-19 17:46:40 +0000253For this specific case, you could also use ``value = dict.setdefault(key,
254getvalue(key))``, but only if the ``getvalue()`` call is cheap enough because it
255is evaluated in all cases.
Georg Brandld7413152009-10-11 21:25:26 +0000256
257
258Why isn't there a switch or case statement in Python?
259-----------------------------------------------------
260
261You can do this easily enough with a sequence of ``if... elif... elif... else``.
262There have been some proposals for switch statement syntax, but there is no
263consensus (yet) on whether and how to do range tests. See :pep:`275` for
264complete details and the current status.
265
266For cases where you need to choose from a very large number of possibilities,
267you can create a dictionary mapping case values to functions to call. For
268example::
269
270 def function_1(...):
271 ...
272
273 functions = {'a': function_1,
274 'b': function_2,
275 'c': self.method_1, ...}
276
277 func = functions[value]
278 func()
279
280For calling methods on objects, you can simplify yet further by using the
281:func:`getattr` built-in to retrieve methods with a particular name::
282
283 def visit_a(self, ...):
284 ...
285 ...
286
287 def dispatch(self, value):
288 method_name = 'visit_' + str(value)
289 method = getattr(self, method_name)
290 method()
291
292It's suggested that you use a prefix for the method names, such as ``visit_`` in
293this example. Without such a prefix, if values are coming from an untrusted
294source, an attacker would be able to call any method on your object.
295
296
297Can't you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?
298--------------------------------------------------------------------------------------------------------
299
300Answer 1: Unfortunately, the interpreter pushes at least one C stack frame for
301each Python stack frame. Also, extensions can call back into Python at almost
302random moments. Therefore, a complete threads implementation requires thread
303support for C.
304
Julien Palarda6e1e412018-07-05 06:31:38 +0200305Answer 2: Fortunately, there is `Stackless Python <https://github.com/stackless-dev/stackless/wiki>`_,
Georg Brandld7413152009-10-11 21:25:26 +0000306which has a completely redesigned interpreter loop that avoids the C stack.
Georg Brandld7413152009-10-11 21:25:26 +0000307
308
Georg Brandl242e6a02013-10-06 10:28:39 +0200309Why can't lambda expressions contain statements?
310------------------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000311
Georg Brandl242e6a02013-10-06 10:28:39 +0200312Python lambda expressions cannot contain statements because Python's syntactic
Georg Brandld7413152009-10-11 21:25:26 +0000313framework can't handle statements nested inside expressions. However, in
314Python, this is not a serious problem. Unlike lambda forms in other languages,
315where they add functionality, Python lambdas are only a shorthand notation if
316you're too lazy to define a function.
317
318Functions are already first class objects in Python, and can be declared in a
Georg Brandl242e6a02013-10-06 10:28:39 +0200319local scope. Therefore the only advantage of using a lambda instead of a
Georg Brandld7413152009-10-11 21:25:26 +0000320locally-defined function is that you don't need to invent a name for the
321function -- but that's just a local variable to which the function object (which
Georg Brandl242e6a02013-10-06 10:28:39 +0200322is exactly the same type of object that a lambda expression yields) is assigned!
Georg Brandld7413152009-10-11 21:25:26 +0000323
324
325Can Python be compiled to machine code, C or some other language?
326-----------------------------------------------------------------
327
Brett Cannon78ffd6c2016-11-18 10:41:28 -0800328`Cython <http://cython.org/>`_ compiles a modified version of Python with
329optional annotations into C extensions. `Nuitka <http://www.nuitka.net/>`_ is
330an up-and-coming compiler of Python into C++ code, aiming to support the full
331Python language. For compiling to Java you can consider
332`VOC <https://voc.readthedocs.io>`_.
Georg Brandld7413152009-10-11 21:25:26 +0000333
Georg Brandld7413152009-10-11 21:25:26 +0000334
335How does Python manage memory?
336------------------------------
337
338The details of Python memory management depend on the implementation. The
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100339standard implementation of Python, :term:`CPython`, uses reference counting to
340detect inaccessible objects, and another mechanism to collect reference cycles,
Georg Brandld7413152009-10-11 21:25:26 +0000341periodically executing a cycle detection algorithm which looks for inaccessible
342cycles and deletes the objects involved. The :mod:`gc` module provides functions
343to perform a garbage collection, obtain debugging statistics, and tune the
344collector's parameters.
345
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100346Other implementations (such as `Jython <http://www.jython.org>`_ or
347`PyPy <http://www.pypy.org>`_), however, can rely on a different mechanism
348such as a full-blown garbage collector. This difference can cause some
349subtle porting problems if your Python code depends on the behavior of the
350reference counting implementation.
Georg Brandld7413152009-10-11 21:25:26 +0000351
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100352In some Python implementations, the following code (which is fine in CPython)
353will probably run out of file descriptors::
Georg Brandld7413152009-10-11 21:25:26 +0000354
Georg Brandl99de4882009-12-20 14:24:06 +0000355 for file in very_long_list_of_files:
Georg Brandld7413152009-10-11 21:25:26 +0000356 f = open(file)
357 c = f.read(1)
358
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100359Indeed, using CPython's reference counting and destructor scheme, each new
360assignment to *f* closes the previous file. With a traditional GC, however,
361those file objects will only get collected (and closed) at varying and possibly
362long intervals.
363
364If you want to write code that will work with any Python implementation,
365you should explicitly close the file or use the :keyword:`with` statement;
366this will work regardless of memory management scheme::
Georg Brandld7413152009-10-11 21:25:26 +0000367
Georg Brandl99de4882009-12-20 14:24:06 +0000368 for file in very_long_list_of_files:
369 with open(file) as f:
370 c = f.read(1)
Georg Brandld7413152009-10-11 21:25:26 +0000371
372
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100373Why doesn't CPython use a more traditional garbage collection scheme?
374---------------------------------------------------------------------
375
376For one thing, this is not a C standard feature and hence it's not portable.
377(Yes, we know about the Boehm GC library. It has bits of assembler code for
378*most* common platforms, not for all of them, and although it is mostly
379transparent, it isn't completely transparent; patches are required to get
380Python to work with it.)
381
382Traditional GC also becomes a problem when Python is embedded into other
383applications. While in a standalone Python it's fine to replace the standard
384malloc() and free() with versions provided by the GC library, an application
385embedding Python may want to have its *own* substitute for malloc() and free(),
386and may not want Python's. Right now, CPython works with anything that
387implements malloc() and free() properly.
388
389
390Why isn't all memory freed when CPython exits?
391----------------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000392
393Objects referenced from the global namespaces of Python modules are not always
394deallocated when Python exits. This may happen if there are circular
395references. There are also certain bits of memory that are allocated by the C
396library that are impossible to free (e.g. a tool like Purify will complain about
397these). Python is, however, aggressive about cleaning up memory on exit and
398does try to destroy every single object.
399
400If you want to force Python to delete certain things on deallocation use the
401:mod:`atexit` module to run a function that will force those deletions.
402
403
404Why are there separate tuple and list data types?
405-------------------------------------------------
406
407Lists and tuples, while similar in many respects, are generally used in
408fundamentally different ways. Tuples can be thought of as being similar to
409Pascal records or C structs; they're small collections of related data which may
410be of different types which are operated on as a group. For example, a
411Cartesian coordinate is appropriately represented as a tuple of two or three
412numbers.
413
414Lists, on the other hand, are more like arrays in other languages. They tend to
415hold a varying number of objects all of which have the same type and which are
416operated on one-by-one. For example, ``os.listdir('.')`` returns a list of
417strings representing the files in the current directory. Functions which
418operate on this output would generally not break if you added another file or
419two to the directory.
420
421Tuples are immutable, meaning that once a tuple has been created, you can't
422replace any of its elements with a new value. Lists are mutable, meaning that
423you can always change a list's elements. Only immutable elements can be used as
424dictionary keys, and hence only tuples and not lists can be used as keys.
425
426
Andrés Delfino8d412782018-07-07 20:25:47 -0300427How are lists implemented in CPython?
428-------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000429
Andrés Delfino8d412782018-07-07 20:25:47 -0300430CPython's lists are really variable-length arrays, not Lisp-style linked lists.
Georg Brandld7413152009-10-11 21:25:26 +0000431The implementation uses a contiguous array of references to other objects, and
432keeps a pointer to this array and the array's length in a list head structure.
433
434This makes indexing a list ``a[i]`` an operation whose cost is independent of
435the size of the list or the value of the index.
436
437When items are appended or inserted, the array of references is resized. Some
438cleverness is applied to improve the performance of appending items repeatedly;
439when the array must be grown, some extra space is allocated so the next few
440times don't require an actual resize.
441
442
Andrés Delfino8d412782018-07-07 20:25:47 -0300443How are dictionaries implemented in CPython?
444--------------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000445
Andrés Delfino8d412782018-07-07 20:25:47 -0300446CPython's dictionaries are implemented as resizable hash tables. Compared to
Georg Brandld7413152009-10-11 21:25:26 +0000447B-trees, this gives better performance for lookup (the most common operation by
448far) under most circumstances, and the implementation is simpler.
449
450Dictionaries work by computing a hash code for each key stored in the dictionary
451using the :func:`hash` built-in function. The hash code varies widely depending
Georg Brandlb20a0192012-03-14 07:50:17 +0100452on the key and a per-process seed; for example, "Python" could hash to
453-539294296 while "python", a string that differs by a single bit, could hash
454to 1142331976. The hash code is then used to calculate a location in an
455internal array where the value will be stored. Assuming that you're storing
456keys that all have different hash values, this means that dictionaries take
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)866c1682018-06-26 13:57:05 +0530457constant time -- O(1), in Big-O notation -- to retrieve a key.
Georg Brandld7413152009-10-11 21:25:26 +0000458
459
460Why must dictionary keys be immutable?
461--------------------------------------
462
463The hash table implementation of dictionaries uses a hash value calculated from
464the key value to find the key. If the key were a mutable object, its value
465could change, and thus its hash could also change. But since whoever changes
466the key object can't tell that it was being used as a dictionary key, it can't
467move the entry around in the dictionary. Then, when you try to look up the same
468object in the dictionary it won't be found because its hash value is different.
469If you tried to look up the old value it wouldn't be found either, because the
470value of the object found in that hash bin would be different.
471
472If you want a dictionary indexed with a list, simply convert the list to a tuple
473first; the function ``tuple(L)`` creates a tuple with the same entries as the
474list ``L``. Tuples are immutable and can therefore be used as dictionary keys.
475
476Some unacceptable solutions that have been proposed:
477
478- Hash lists by their address (object ID). This doesn't work because if you
479 construct a new list with the same value it won't be found; e.g.::
480
Georg Brandl99de4882009-12-20 14:24:06 +0000481 mydict = {[1, 2]: '12'}
482 print(mydict[[1, 2]])
Georg Brandld7413152009-10-11 21:25:26 +0000483
Stéphane Wirtele483f022018-10-26 12:52:11 +0200484 would raise a :exc:`KeyError` exception because the id of the ``[1, 2]`` used in the
Georg Brandld7413152009-10-11 21:25:26 +0000485 second line differs from that in the first line. In other words, dictionary
486 keys should be compared using ``==``, not using :keyword:`is`.
487
488- Make a copy when using a list as a key. This doesn't work because the list,
489 being a mutable object, could contain a reference to itself, and then the
490 copying code would run into an infinite loop.
491
492- Allow lists as keys but tell the user not to modify them. This would allow a
493 class of hard-to-track bugs in programs when you forgot or modified a list by
494 accident. It also invalidates an important invariant of dictionaries: every
495 value in ``d.keys()`` is usable as a key of the dictionary.
496
497- Mark lists as read-only once they are used as a dictionary key. The problem
498 is that it's not just the top-level object that could change its value; you
499 could use a tuple containing a list as a key. Entering anything as a key into
500 a dictionary would require marking all objects reachable from there as
501 read-only -- and again, self-referential objects could cause an infinite loop.
502
503There is a trick to get around this if you need to, but use it at your own risk:
504You can wrap a mutable structure inside a class instance which has both a
Georg Brandl99de4882009-12-20 14:24:06 +0000505:meth:`__eq__` and a :meth:`__hash__` method. You must then make sure that the
Georg Brandld7413152009-10-11 21:25:26 +0000506hash value for all such wrapper objects that reside in a dictionary (or other
507hash based structure), remain fixed while the object is in the dictionary (or
508other structure). ::
509
510 class ListWrapper:
511 def __init__(self, the_list):
512 self.the_list = the_list
Serhiy Storchakadba90392016-05-10 12:01:23 +0300513
Georg Brandl99de4882009-12-20 14:24:06 +0000514 def __eq__(self, other):
Georg Brandld7413152009-10-11 21:25:26 +0000515 return self.the_list == other.the_list
Serhiy Storchakadba90392016-05-10 12:01:23 +0300516
Georg Brandld7413152009-10-11 21:25:26 +0000517 def __hash__(self):
518 l = self.the_list
519 result = 98767 - len(l)*555
Georg Brandl99de4882009-12-20 14:24:06 +0000520 for i, el in enumerate(l):
Georg Brandld7413152009-10-11 21:25:26 +0000521 try:
Georg Brandl99de4882009-12-20 14:24:06 +0000522 result = result + (hash(el) % 9999999) * 1001 + i
523 except Exception:
Georg Brandld7413152009-10-11 21:25:26 +0000524 result = (result % 7777777) + i * 333
525 return result
526
527Note that the hash computation is complicated by the possibility that some
528members of the list may be unhashable and also by the possibility of arithmetic
529overflow.
530
Georg Brandl99de4882009-12-20 14:24:06 +0000531Furthermore it must always be the case that if ``o1 == o2`` (ie ``o1.__eq__(o2)
532is True``) then ``hash(o1) == hash(o2)`` (ie, ``o1.__hash__() == o2.__hash__()``),
Georg Brandld7413152009-10-11 21:25:26 +0000533regardless of whether the object is in a dictionary or not. If you fail to meet
534these restrictions dictionaries and other hash based structures will misbehave.
535
536In the case of ListWrapper, whenever the wrapper object is in a dictionary the
537wrapped list must not change to avoid anomalies. Don't do this unless you are
538prepared to think hard about the requirements and the consequences of not
539meeting them correctly. Consider yourself warned.
540
541
542Why doesn't list.sort() return the sorted list?
543-----------------------------------------------
544
545In situations where performance matters, making a copy of the list just to sort
546it would be wasteful. Therefore, :meth:`list.sort` sorts the list in place. In
547order to remind you of that fact, it does not return the sorted list. This way,
548you won't be fooled into accidentally overwriting a list when you need a sorted
549copy but also need to keep the unsorted version around.
550
Antoine Pitroudec0f212011-12-03 23:08:57 +0100551If you want to return a new list, use the built-in :func:`sorted` function
552instead. This function creates a new list from a provided iterable, sorts
553it and returns it. For example, here's how to iterate over the keys of a
554dictionary in sorted order::
Georg Brandld7413152009-10-11 21:25:26 +0000555
Georg Brandl99de4882009-12-20 14:24:06 +0000556 for key in sorted(mydict):
Serhiy Storchakadba90392016-05-10 12:01:23 +0300557 ... # do whatever with mydict[key]...
Georg Brandld7413152009-10-11 21:25:26 +0000558
559
560How do you specify and enforce an interface spec in Python?
561-----------------------------------------------------------
562
563An interface specification for a module as provided by languages such as C++ and
564Java describes the prototypes for the methods and functions of the module. Many
565feel that compile-time enforcement of interface specifications helps in the
566construction of large programs.
567
568Python 2.6 adds an :mod:`abc` module that lets you define Abstract Base Classes
569(ABCs). You can then use :func:`isinstance` and :func:`issubclass` to check
570whether an instance or a class implements a particular ABC. The
Éric Araujob8edbdf2011-09-01 05:57:12 +0200571:mod:`collections.abc` module defines a set of useful ABCs such as
Serhiy Storchakabfdcd432013-10-13 23:09:14 +0300572:class:`~collections.abc.Iterable`, :class:`~collections.abc.Container`, and
573:class:`~collections.abc.MutableMapping`.
Georg Brandld7413152009-10-11 21:25:26 +0000574
575For Python, many of the advantages of interface specifications can be obtained
576by an appropriate test discipline for components. There is also a tool,
577PyChecker, which can be used to find problems due to subclassing.
578
579A good test suite for a module can both provide a regression test and serve as a
580module interface specification and a set of examples. Many Python modules can
581be run as a script to provide a simple "self test." Even modules which use
582complex external interfaces can often be tested in isolation using trivial
583"stub" emulations of the external interface. The :mod:`doctest` and
584:mod:`unittest` modules or third-party test frameworks can be used to construct
585exhaustive test suites that exercise every line of code in a module.
586
587An appropriate testing discipline can help build large complex applications in
588Python as well as having interface specifications would. In fact, it can be
589better because an interface specification cannot test certain properties of a
590program. For example, the :meth:`append` method is expected to add new elements
591to the end of some internal list; an interface specification cannot test that
592your :meth:`append` implementation will actually do this correctly, but it's
593trivial to check this property in a test suite.
594
Ilya Kamenshchikova0f71192019-07-16 17:13:38 +0200595Writing test suites is very helpful, and you might want to design your code to
596make it easily tested. One increasingly popular technique, test-driven
597development, calls for writing parts of the test suite first, before you write
598any of the actual code. Of course Python allows you to be sloppy and not write
599test cases at all.
Georg Brandld7413152009-10-11 21:25:26 +0000600
601
Georg Brandld7413152009-10-11 21:25:26 +0000602Why is there no goto?
603---------------------
604
605You can use exceptions to provide a "structured goto" that even works across
606function calls. Many feel that exceptions can conveniently emulate all
607reasonable uses of the "go" or "goto" constructs of C, Fortran, and other
608languages. For example::
609
Ezio Melotti19cdee82013-01-05 06:53:27 +0200610 class label(Exception): pass # declare a label
Georg Brandld7413152009-10-11 21:25:26 +0000611
612 try:
Serhiy Storchakadba90392016-05-10 12:01:23 +0300613 ...
614 if condition: raise label() # goto label
615 ...
Georg Brandl99de4882009-12-20 14:24:06 +0000616 except label: # where to goto
Serhiy Storchakadba90392016-05-10 12:01:23 +0300617 pass
Georg Brandld7413152009-10-11 21:25:26 +0000618 ...
619
620This doesn't allow you to jump into the middle of a loop, but that's usually
621considered an abuse of goto anyway. Use sparingly.
622
623
624Why can't raw strings (r-strings) end with a backslash?
625-------------------------------------------------------
626
627More precisely, they can't end with an odd number of backslashes: the unpaired
628backslash at the end escapes the closing quote character, leaving an
629unterminated string.
630
631Raw strings were designed to ease creating input for processors (chiefly regular
632expression engines) that want to do their own backslash escape processing. Such
633processors consider an unmatched trailing backslash to be an error anyway, so
634raw strings disallow that. In return, they allow you to pass on the string
635quote character by escaping it with a backslash. These rules work well when
636r-strings are used for their intended purpose.
637
638If you're trying to build Windows pathnames, note that all Windows system calls
639accept forward slashes too::
640
Georg Brandl99de4882009-12-20 14:24:06 +0000641 f = open("/mydir/file.txt") # works fine!
Georg Brandld7413152009-10-11 21:25:26 +0000642
643If you're trying to build a pathname for a DOS command, try e.g. one of ::
644
645 dir = r"\this\is\my\dos\dir" "\\"
646 dir = r"\this\is\my\dos\dir\ "[:-1]
647 dir = "\\this\\is\\my\\dos\\dir\\"
648
649
650Why doesn't Python have a "with" statement for attribute assignments?
651---------------------------------------------------------------------
652
653Python has a 'with' statement that wraps the execution of a block, calling code
654on the entrance and exit from the block. Some language have a construct that
655looks like this::
656
657 with obj:
Benjamin Peterson1baf4652009-12-31 03:11:23 +0000658 a = 1 # equivalent to obj.a = 1
Georg Brandld7413152009-10-11 21:25:26 +0000659 total = total + 1 # obj.total = obj.total + 1
660
661In Python, such a construct would be ambiguous.
662
663Other languages, such as Object Pascal, Delphi, and C++, use static types, so
664it's possible to know, in an unambiguous way, what member is being assigned
665to. This is the main point of static typing -- the compiler *always* knows the
666scope of every variable at compile time.
667
668Python uses dynamic types. It is impossible to know in advance which attribute
669will be referenced at runtime. Member attributes may be added or removed from
670objects on the fly. This makes it impossible to know, from a simple reading,
671what attribute is being referenced: a local one, a global one, or a member
672attribute?
673
674For instance, take the following incomplete snippet::
675
676 def foo(a):
677 with a:
Georg Brandl99de4882009-12-20 14:24:06 +0000678 print(x)
Georg Brandld7413152009-10-11 21:25:26 +0000679
680The snippet assumes that "a" must have a member attribute called "x". However,
681there is nothing in Python that tells the interpreter this. What should happen
682if "a" is, let us say, an integer? If there is a global variable named "x",
683will it be used inside the with block? As you see, the dynamic nature of Python
684makes such choices much harder.
685
686The primary benefit of "with" and similar language features (reduction of code
687volume) can, however, easily be achieved in Python by assignment. Instead of::
688
Georg Brandl99de4882009-12-20 14:24:06 +0000689 function(args).mydict[index][index].a = 21
690 function(args).mydict[index][index].b = 42
691 function(args).mydict[index][index].c = 63
Georg Brandld7413152009-10-11 21:25:26 +0000692
693write this::
694
Georg Brandl99de4882009-12-20 14:24:06 +0000695 ref = function(args).mydict[index][index]
Georg Brandld7413152009-10-11 21:25:26 +0000696 ref.a = 21
697 ref.b = 42
698 ref.c = 63
699
700This also has the side-effect of increasing execution speed because name
701bindings are resolved at run-time in Python, and the second version only needs
Georg Brandl99de4882009-12-20 14:24:06 +0000702to perform the resolution once.
Georg Brandld7413152009-10-11 21:25:26 +0000703
704
705Why are colons required for the if/while/def/class statements?
706--------------------------------------------------------------
707
708The colon is required primarily to enhance readability (one of the results of
709the experimental ABC language). Consider this::
710
711 if a == b
Georg Brandl99de4882009-12-20 14:24:06 +0000712 print(a)
Georg Brandld7413152009-10-11 21:25:26 +0000713
714versus ::
715
716 if a == b:
Georg Brandl99de4882009-12-20 14:24:06 +0000717 print(a)
Georg Brandld7413152009-10-11 21:25:26 +0000718
719Notice how the second one is slightly easier to read. Notice further how a
720colon sets off the example in this FAQ answer; it's a standard usage in English.
721
722Another minor reason is that the colon makes it easier for editors with syntax
723highlighting; they can look for colons to decide when indentation needs to be
724increased instead of having to do a more elaborate parsing of the program text.
725
726
727Why does Python allow commas at the end of lists and tuples?
728------------------------------------------------------------
729
730Python lets you add a trailing comma at the end of lists, tuples, and
731dictionaries::
732
733 [1, 2, 3,]
734 ('a', 'b', 'c',)
735 d = {
736 "A": [1, 5],
737 "B": [6, 7], # last trailing comma is optional but good style
738 }
739
740
741There are several reasons to allow this.
742
743When you have a literal value for a list, tuple, or dictionary spread across
744multiple lines, it's easier to add more elements because you don't have to
Georg Brandl7b8c1322013-04-14 10:31:06 +0200745remember to add a comma to the previous line. The lines can also be reordered
746without creating a syntax error.
Georg Brandld7413152009-10-11 21:25:26 +0000747
748Accidentally omitting the comma can lead to errors that are hard to diagnose.
749For example::
750
751 x = [
752 "fee",
753 "fie"
754 "foo",
755 "fum"
756 ]
757
758This list looks like it has four elements, but it actually contains three:
759"fee", "fiefoo" and "fum". Always adding the comma avoids this source of error.
760
761Allowing the trailing comma may also make programmatic code generation easier.