blob: 81c0f474ac16241fb4780e15d8fc4d1a7f887994 [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
27indentation leads you to believe otherwise. Even experienced C programmers will
28sometimes stare at it a long time wondering why ``y`` is being decremented even
29for ``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.
33If you're used to reading and writing code that uses one style, you will feel at
34least slightly uneasy when reading (or being required to write) another style.
35
Georg Brandl6faee4e2010-09-21 14:48:28 +000036Many coding styles place begin/end brackets on a line by themselves. This makes
Georg Brandld7413152009-10-11 21:25:26 +000037programs considerably longer and wastes valuable screen space, making it harder
38to get a good overview of a program. Ideally, a function should fit on one
Serhiy Storchakac7b1a0b2016-11-26 13:43:28 +020039screen (say, 20--30 lines). 20 lines of Python can do a lot more work than 20
Georg Brandld7413152009-10-11 21:25:26 +000040lines of C. This is not solely due to the lack of begin/end brackets -- the
41lack of declarations and the high-level data types are also responsible -- but
42the indentation-based syntax certainly helps.
43
44
45Why am I getting strange results with simple arithmetic operations?
46-------------------------------------------------------------------
47
48See the next question.
49
50
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010051Why are floating-point calculations so inaccurate?
Georg Brandld7413152009-10-11 21:25:26 +000052--------------------------------------------------
53
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010054Users are often surprised by results like this::
Georg Brandld7413152009-10-11 21:25:26 +000055
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010056 >>> 1.2 - 1.0
Georg Brandl9205e9e2014-10-06 17:51:09 +020057 0.19999999999999996
Georg Brandld7413152009-10-11 21:25:26 +000058
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010059and think it is a bug in Python. It's not. This has little to do with Python,
60and much more to do with how the underlying platform handles floating-point
61numbers.
Georg Brandld7413152009-10-11 21:25:26 +000062
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010063The :class:`float` type in CPython uses a C ``double`` for storage. A
64:class:`float` object's value is stored in binary floating-point with a fixed
65precision (typically 53 bits) and Python uses C operations, which in turn rely
66on the hardware implementation in the processor, to perform floating-point
67operations. This means that as far as floating-point operations are concerned,
68Python behaves like many popular languages including C and Java.
Georg Brandld7413152009-10-11 21:25:26 +000069
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010070Many numbers that can be written easily in decimal notation cannot be expressed
71exactly in binary floating-point. For example, after::
Georg Brandld7413152009-10-11 21:25:26 +000072
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010073 >>> x = 1.2
Georg Brandld7413152009-10-11 21:25:26 +000074
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010075the value stored for ``x`` is a (very good) approximation to the decimal value
76``1.2``, but is not exactly equal to it. On a typical machine, the actual
77stored value is::
Georg Brandld7413152009-10-11 21:25:26 +000078
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010079 1.0011001100110011001100110011001100110011001100110011 (binary)
Georg Brandld7413152009-10-11 21:25:26 +000080
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010081which is exactly::
Georg Brandld7413152009-10-11 21:25:26 +000082
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010083 1.1999999999999999555910790149937383830547332763671875 (decimal)
Georg Brandld7413152009-10-11 21:25:26 +000084
Serhiy Storchakac7b1a0b2016-11-26 13:43:28 +020085The typical precision of 53 bits provides Python floats with 15--16
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010086decimal digits of accuracy.
Georg Brandld7413152009-10-11 21:25:26 +000087
Mark Dickinsonba3b0d82012-05-13 21:00:35 +010088For a fuller explanation, please see the :ref:`floating point arithmetic
89<tut-fp-issues>` chapter in the Python tutorial.
Georg Brandld7413152009-10-11 21:25:26 +000090
91
92Why are Python strings immutable?
93---------------------------------
94
95There are several advantages.
96
97One is performance: knowing that a string is immutable means we can allocate
98space for it at creation time, and the storage requirements are fixed and
99unchanging. This is also one of the reasons for the distinction between tuples
100and lists.
101
102Another advantage is that strings in Python are considered as "elemental" as
103numbers. No amount of activity will change the value 8 to anything else, and in
104Python, no amount of activity will change the string "eight" to anything else.
105
106
107.. _why-self:
108
109Why must 'self' be used explicitly in method definitions and calls?
110-------------------------------------------------------------------
111
112The idea was borrowed from Modula-3. It turns out to be very useful, for a
113variety of reasons.
114
115First, it's more obvious that you are using a method or instance attribute
116instead of a local variable. Reading ``self.x`` or ``self.meth()`` makes it
117absolutely clear that an instance variable or method is used even if you don't
118know the class definition by heart. In C++, you can sort of tell by the lack of
119a local variable declaration (assuming globals are rare or easily recognizable)
120-- but in Python, there are no local variable declarations, so you'd have to
121look up the class definition to be sure. Some C++ and Java coding standards
122call for instance attributes to have an ``m_`` prefix, so this explicitness is
123still useful in those languages, too.
124
125Second, it means that no special syntax is necessary if you want to explicitly
126reference or call the method from a particular class. In C++, if you want to
127use a method from a base class which is overridden in a derived class, you have
Georg Brandl99de4882009-12-20 14:24:06 +0000128to use the ``::`` operator -- in Python you can write
129``baseclass.methodname(self, <argument list>)``. This is particularly useful
130for :meth:`__init__` methods, and in general in cases where a derived class
131method wants to extend the base class method of the same name and thus has to
132call the base class method somehow.
Georg Brandld7413152009-10-11 21:25:26 +0000133
134Finally, for instance variables it solves a syntactic problem with assignment:
135since local variables in Python are (by definition!) those variables to which a
Georg Brandl99de4882009-12-20 14:24:06 +0000136value is assigned in a function body (and that aren't explicitly declared
137global), there has to be some way to tell the interpreter that an assignment was
138meant to assign to an instance variable instead of to a local variable, and it
139should preferably be syntactic (for efficiency reasons). C++ does this through
Georg Brandld7413152009-10-11 21:25:26 +0000140declarations, but Python doesn't have declarations and it would be a pity having
Georg Brandl99de4882009-12-20 14:24:06 +0000141to introduce them just for this purpose. Using the explicit ``self.var`` solves
Georg Brandld7413152009-10-11 21:25:26 +0000142this nicely. Similarly, for using instance variables, having to write
Georg Brandl99de4882009-12-20 14:24:06 +0000143``self.var`` means that references to unqualified names inside a method don't
144have to search the instance's directories. To put it another way, local
145variables and instance variables live in two different namespaces, and you need
146to tell Python which namespace to use.
Georg Brandld7413152009-10-11 21:25:26 +0000147
148
149Why can't I use an assignment in an expression?
150-----------------------------------------------
151
Miss Islington (bot)be2aa582019-09-11 08:12:09 -0700152Starting in Python 3.8, you can!
Georg Brandld7413152009-10-11 21:25:26 +0000153
Miss Islington (bot)be2aa582019-09-11 08:12:09 -0700154Assignment expressions using the walrus operator `:=` assign a variable in an
155expression::
Georg Brandld7413152009-10-11 21:25:26 +0000156
Miss Islington (bot)be2aa582019-09-11 08:12:09 -0700157 while chunk := fp.read(200):
158 print(chunk)
Georg Brandld7413152009-10-11 21:25:26 +0000159
Miss Islington (bot)be2aa582019-09-11 08:12:09 -0700160See :pep:`572` for more information.
Georg Brandld7413152009-10-11 21:25:26 +0000161
162
163
164Why does Python use methods for some functionality (e.g. list.index()) but functions for other (e.g. len(list))?
165----------------------------------------------------------------------------------------------------------------
166
INADA Naokic48e26d2018-07-31 14:49:22 +0900167As Guido said:
Georg Brandld7413152009-10-11 21:25:26 +0000168
INADA Naokic48e26d2018-07-31 14:49:22 +0900169 (a) For some operations, prefix notation just reads better than
170 postfix -- prefix (and infix!) operations have a long tradition in
171 mathematics which likes notations where the visuals help the
172 mathematician thinking about a problem. Compare the easy with which we
173 rewrite a formula like x*(a+b) into x*a + x*b to the clumsiness of
174 doing the same thing using a raw OO notation.
Georg Brandld7413152009-10-11 21:25:26 +0000175
INADA Naokic48e26d2018-07-31 14:49:22 +0900176 (b) When I read code that says len(x) I *know* that it is asking for
177 the length of something. This tells me two things: the result is an
178 integer, and the argument is some kind of container. To the contrary,
179 when I read x.len(), I have to already know that x is some kind of
180 container implementing an interface or inheriting from a class that
181 has a standard len(). Witness the confusion we occasionally have when
182 a class that is not implementing a mapping has a get() or keys()
183 method, or something that isn't a file has a write() method.
Georg Brandld7413152009-10-11 21:25:26 +0000184
INADA Naokic48e26d2018-07-31 14:49:22 +0900185 -- https://mail.python.org/pipermail/python-3000/2006-November/004643.html
Georg Brandld7413152009-10-11 21:25:26 +0000186
187
188Why is join() a string method instead of a list or tuple method?
189----------------------------------------------------------------
190
191Strings became much more like other standard types starting in Python 1.6, when
192methods were added which give the same functionality that has always been
193available using the functions of the string module. Most of these new methods
194have been widely accepted, but the one which appears to make some programmers
195feel uncomfortable is::
196
197 ", ".join(['1', '2', '4', '8', '16'])
198
199which gives the result::
200
201 "1, 2, 4, 8, 16"
202
203There are two common arguments against this usage.
204
205The first runs along the lines of: "It looks really ugly using a method of a
206string literal (string constant)", to which the answer is that it might, but a
207string literal is just a fixed value. If the methods are to be allowed on names
208bound to strings there is no logical reason to make them unavailable on
209literals.
210
211The second objection is typically cast as: "I am really telling a sequence to
212join its members together with a string constant". Sadly, you aren't. For some
213reason there seems to be much less difficulty with having :meth:`~str.split` as
214a string method, since in that case it is easy to see that ::
215
216 "1, 2, 4, 8, 16".split(", ")
217
218is an instruction to a string literal to return the substrings delimited by the
Georg Brandl99de4882009-12-20 14:24:06 +0000219given separator (or, by default, arbitrary runs of white space).
Georg Brandld7413152009-10-11 21:25:26 +0000220
221:meth:`~str.join` is a string method because in using it you are telling the
222separator string to iterate over a sequence of strings and insert itself between
223adjacent elements. This method can be used with any argument which obeys the
224rules for sequence objects, including any new classes you might define yourself.
Georg Brandl99de4882009-12-20 14:24:06 +0000225Similar methods exist for bytes and bytearray objects.
Georg Brandld7413152009-10-11 21:25:26 +0000226
227
228How fast are exceptions?
229------------------------
230
Georg Brandl12c3cd72012-03-17 16:58:05 +0100231A try/except block is extremely efficient if no exceptions are raised. Actually
232catching an exception is expensive. In versions of Python prior to 2.0 it was
233common to use this idiom::
Georg Brandld7413152009-10-11 21:25:26 +0000234
235 try:
Georg Brandl99de4882009-12-20 14:24:06 +0000236 value = mydict[key]
Georg Brandld7413152009-10-11 21:25:26 +0000237 except KeyError:
Georg Brandl99de4882009-12-20 14:24:06 +0000238 mydict[key] = getvalue(key)
239 value = mydict[key]
Georg Brandld7413152009-10-11 21:25:26 +0000240
241This only made sense when you expected the dict to have the key almost all the
242time. If that wasn't the case, you coded it like this::
243
Georg Brandl12c3cd72012-03-17 16:58:05 +0100244 if key in mydict:
Georg Brandl99de4882009-12-20 14:24:06 +0000245 value = mydict[key]
Georg Brandld7413152009-10-11 21:25:26 +0000246 else:
Georg Brandl12c3cd72012-03-17 16:58:05 +0100247 value = mydict[key] = getvalue(key)
Georg Brandld7413152009-10-11 21:25:26 +0000248
Georg Brandlbfe95ac2009-12-19 17:46:40 +0000249For this specific case, you could also use ``value = dict.setdefault(key,
250getvalue(key))``, but only if the ``getvalue()`` call is cheap enough because it
251is evaluated in all cases.
Georg Brandld7413152009-10-11 21:25:26 +0000252
253
254Why isn't there a switch or case statement in Python?
255-----------------------------------------------------
256
257You can do this easily enough with a sequence of ``if... elif... elif... else``.
258There have been some proposals for switch statement syntax, but there is no
259consensus (yet) on whether and how to do range tests. See :pep:`275` for
260complete details and the current status.
261
262For cases where you need to choose from a very large number of possibilities,
263you can create a dictionary mapping case values to functions to call. For
264example::
265
266 def function_1(...):
267 ...
268
269 functions = {'a': function_1,
270 'b': function_2,
271 'c': self.method_1, ...}
272
273 func = functions[value]
274 func()
275
276For calling methods on objects, you can simplify yet further by using the
277:func:`getattr` built-in to retrieve methods with a particular name::
278
279 def visit_a(self, ...):
280 ...
281 ...
282
283 def dispatch(self, value):
284 method_name = 'visit_' + str(value)
285 method = getattr(self, method_name)
286 method()
287
288It's suggested that you use a prefix for the method names, such as ``visit_`` in
289this example. Without such a prefix, if values are coming from an untrusted
290source, an attacker would be able to call any method on your object.
291
292
293Can't you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?
294--------------------------------------------------------------------------------------------------------
295
296Answer 1: Unfortunately, the interpreter pushes at least one C stack frame for
297each Python stack frame. Also, extensions can call back into Python at almost
298random moments. Therefore, a complete threads implementation requires thread
299support for C.
300
Julien Palarda6e1e412018-07-05 06:31:38 +0200301Answer 2: Fortunately, there is `Stackless Python <https://github.com/stackless-dev/stackless/wiki>`_,
Georg Brandld7413152009-10-11 21:25:26 +0000302which has a completely redesigned interpreter loop that avoids the C stack.
Georg Brandld7413152009-10-11 21:25:26 +0000303
304
Georg Brandl242e6a02013-10-06 10:28:39 +0200305Why can't lambda expressions contain statements?
306------------------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000307
Georg Brandl242e6a02013-10-06 10:28:39 +0200308Python lambda expressions cannot contain statements because Python's syntactic
Georg Brandld7413152009-10-11 21:25:26 +0000309framework can't handle statements nested inside expressions. However, in
310Python, this is not a serious problem. Unlike lambda forms in other languages,
311where they add functionality, Python lambdas are only a shorthand notation if
312you're too lazy to define a function.
313
314Functions are already first class objects in Python, and can be declared in a
Georg Brandl242e6a02013-10-06 10:28:39 +0200315local scope. Therefore the only advantage of using a lambda instead of a
Georg Brandld7413152009-10-11 21:25:26 +0000316locally-defined function is that you don't need to invent a name for the
317function -- but that's just a local variable to which the function object (which
Georg Brandl242e6a02013-10-06 10:28:39 +0200318is exactly the same type of object that a lambda expression yields) is assigned!
Georg Brandld7413152009-10-11 21:25:26 +0000319
320
321Can Python be compiled to machine code, C or some other language?
322-----------------------------------------------------------------
323
Brett Cannon78ffd6c2016-11-18 10:41:28 -0800324`Cython <http://cython.org/>`_ compiles a modified version of Python with
325optional annotations into C extensions. `Nuitka <http://www.nuitka.net/>`_ is
326an up-and-coming compiler of Python into C++ code, aiming to support the full
327Python language. For compiling to Java you can consider
328`VOC <https://voc.readthedocs.io>`_.
Georg Brandld7413152009-10-11 21:25:26 +0000329
Georg Brandld7413152009-10-11 21:25:26 +0000330
331How does Python manage memory?
332------------------------------
333
334The details of Python memory management depend on the implementation. The
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100335standard implementation of Python, :term:`CPython`, uses reference counting to
336detect inaccessible objects, and another mechanism to collect reference cycles,
Georg Brandld7413152009-10-11 21:25:26 +0000337periodically executing a cycle detection algorithm which looks for inaccessible
338cycles and deletes the objects involved. The :mod:`gc` module provides functions
339to perform a garbage collection, obtain debugging statistics, and tune the
340collector's parameters.
341
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100342Other implementations (such as `Jython <http://www.jython.org>`_ or
343`PyPy <http://www.pypy.org>`_), however, can rely on a different mechanism
344such as a full-blown garbage collector. This difference can cause some
345subtle porting problems if your Python code depends on the behavior of the
346reference counting implementation.
Georg Brandld7413152009-10-11 21:25:26 +0000347
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100348In some Python implementations, the following code (which is fine in CPython)
349will probably run out of file descriptors::
Georg Brandld7413152009-10-11 21:25:26 +0000350
Georg Brandl99de4882009-12-20 14:24:06 +0000351 for file in very_long_list_of_files:
Georg Brandld7413152009-10-11 21:25:26 +0000352 f = open(file)
353 c = f.read(1)
354
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100355Indeed, using CPython's reference counting and destructor scheme, each new
356assignment to *f* closes the previous file. With a traditional GC, however,
357those file objects will only get collected (and closed) at varying and possibly
358long intervals.
359
360If you want to write code that will work with any Python implementation,
361you should explicitly close the file or use the :keyword:`with` statement;
362this will work regardless of memory management scheme::
Georg Brandld7413152009-10-11 21:25:26 +0000363
Georg Brandl99de4882009-12-20 14:24:06 +0000364 for file in very_long_list_of_files:
365 with open(file) as f:
366 c = f.read(1)
Georg Brandld7413152009-10-11 21:25:26 +0000367
368
Antoine Pitrouc561a9a2011-12-03 23:06:50 +0100369Why doesn't CPython use a more traditional garbage collection scheme?
370---------------------------------------------------------------------
371
372For one thing, this is not a C standard feature and hence it's not portable.
373(Yes, we know about the Boehm GC library. It has bits of assembler code for
374*most* common platforms, not for all of them, and although it is mostly
375transparent, it isn't completely transparent; patches are required to get
376Python to work with it.)
377
378Traditional GC also becomes a problem when Python is embedded into other
379applications. While in a standalone Python it's fine to replace the standard
380malloc() and free() with versions provided by the GC library, an application
381embedding Python may want to have its *own* substitute for malloc() and free(),
382and may not want Python's. Right now, CPython works with anything that
383implements malloc() and free() properly.
384
385
386Why isn't all memory freed when CPython exits?
387----------------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000388
389Objects referenced from the global namespaces of Python modules are not always
390deallocated when Python exits. This may happen if there are circular
391references. There are also certain bits of memory that are allocated by the C
392library that are impossible to free (e.g. a tool like Purify will complain about
393these). Python is, however, aggressive about cleaning up memory on exit and
394does try to destroy every single object.
395
396If you want to force Python to delete certain things on deallocation use the
397:mod:`atexit` module to run a function that will force those deletions.
398
399
400Why are there separate tuple and list data types?
401-------------------------------------------------
402
403Lists and tuples, while similar in many respects, are generally used in
404fundamentally different ways. Tuples can be thought of as being similar to
405Pascal records or C structs; they're small collections of related data which may
406be of different types which are operated on as a group. For example, a
407Cartesian coordinate is appropriately represented as a tuple of two or three
408numbers.
409
410Lists, on the other hand, are more like arrays in other languages. They tend to
411hold a varying number of objects all of which have the same type and which are
412operated on one-by-one. For example, ``os.listdir('.')`` returns a list of
413strings representing the files in the current directory. Functions which
414operate on this output would generally not break if you added another file or
415two to the directory.
416
417Tuples are immutable, meaning that once a tuple has been created, you can't
418replace any of its elements with a new value. Lists are mutable, meaning that
419you can always change a list's elements. Only immutable elements can be used as
420dictionary keys, and hence only tuples and not lists can be used as keys.
421
422
Andrés Delfino8d412782018-07-07 20:25:47 -0300423How are lists implemented in CPython?
424-------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000425
Andrés Delfino8d412782018-07-07 20:25:47 -0300426CPython's lists are really variable-length arrays, not Lisp-style linked lists.
Georg Brandld7413152009-10-11 21:25:26 +0000427The implementation uses a contiguous array of references to other objects, and
428keeps a pointer to this array and the array's length in a list head structure.
429
430This makes indexing a list ``a[i]`` an operation whose cost is independent of
431the size of the list or the value of the index.
432
433When items are appended or inserted, the array of references is resized. Some
434cleverness is applied to improve the performance of appending items repeatedly;
435when the array must be grown, some extra space is allocated so the next few
436times don't require an actual resize.
437
438
Andrés Delfino8d412782018-07-07 20:25:47 -0300439How are dictionaries implemented in CPython?
440--------------------------------------------
Georg Brandld7413152009-10-11 21:25:26 +0000441
Andrés Delfino8d412782018-07-07 20:25:47 -0300442CPython's dictionaries are implemented as resizable hash tables. Compared to
Georg Brandld7413152009-10-11 21:25:26 +0000443B-trees, this gives better performance for lookup (the most common operation by
444far) under most circumstances, and the implementation is simpler.
445
446Dictionaries work by computing a hash code for each key stored in the dictionary
447using the :func:`hash` built-in function. The hash code varies widely depending
Georg Brandlb20a0192012-03-14 07:50:17 +0100448on the key and a per-process seed; for example, "Python" could hash to
449-539294296 while "python", a string that differs by a single bit, could hash
450to 1142331976. The hash code is then used to calculate a location in an
451internal array where the value will be stored. Assuming that you're storing
452keys that all have different hash values, this means that dictionaries take
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)866c1682018-06-26 13:57:05 +0530453constant time -- O(1), in Big-O notation -- to retrieve a key.
Georg Brandld7413152009-10-11 21:25:26 +0000454
455
456Why must dictionary keys be immutable?
457--------------------------------------
458
459The hash table implementation of dictionaries uses a hash value calculated from
460the key value to find the key. If the key were a mutable object, its value
461could change, and thus its hash could also change. But since whoever changes
462the key object can't tell that it was being used as a dictionary key, it can't
463move the entry around in the dictionary. Then, when you try to look up the same
464object in the dictionary it won't be found because its hash value is different.
465If you tried to look up the old value it wouldn't be found either, because the
466value of the object found in that hash bin would be different.
467
468If you want a dictionary indexed with a list, simply convert the list to a tuple
469first; the function ``tuple(L)`` creates a tuple with the same entries as the
470list ``L``. Tuples are immutable and can therefore be used as dictionary keys.
471
472Some unacceptable solutions that have been proposed:
473
474- Hash lists by their address (object ID). This doesn't work because if you
475 construct a new list with the same value it won't be found; e.g.::
476
Georg Brandl99de4882009-12-20 14:24:06 +0000477 mydict = {[1, 2]: '12'}
478 print(mydict[[1, 2]])
Georg Brandld7413152009-10-11 21:25:26 +0000479
Stéphane Wirtele483f022018-10-26 12:52:11 +0200480 would raise a :exc:`KeyError` exception because the id of the ``[1, 2]`` used in the
Georg Brandld7413152009-10-11 21:25:26 +0000481 second line differs from that in the first line. In other words, dictionary
482 keys should be compared using ``==``, not using :keyword:`is`.
483
484- Make a copy when using a list as a key. This doesn't work because the list,
485 being a mutable object, could contain a reference to itself, and then the
486 copying code would run into an infinite loop.
487
488- Allow lists as keys but tell the user not to modify them. This would allow a
489 class of hard-to-track bugs in programs when you forgot or modified a list by
490 accident. It also invalidates an important invariant of dictionaries: every
491 value in ``d.keys()`` is usable as a key of the dictionary.
492
493- Mark lists as read-only once they are used as a dictionary key. The problem
494 is that it's not just the top-level object that could change its value; you
495 could use a tuple containing a list as a key. Entering anything as a key into
496 a dictionary would require marking all objects reachable from there as
497 read-only -- and again, self-referential objects could cause an infinite loop.
498
499There is a trick to get around this if you need to, but use it at your own risk:
500You can wrap a mutable structure inside a class instance which has both a
Georg Brandl99de4882009-12-20 14:24:06 +0000501:meth:`__eq__` and a :meth:`__hash__` method. You must then make sure that the
Georg Brandld7413152009-10-11 21:25:26 +0000502hash value for all such wrapper objects that reside in a dictionary (or other
503hash based structure), remain fixed while the object is in the dictionary (or
504other structure). ::
505
506 class ListWrapper:
507 def __init__(self, the_list):
508 self.the_list = the_list
Serhiy Storchakadba90392016-05-10 12:01:23 +0300509
Georg Brandl99de4882009-12-20 14:24:06 +0000510 def __eq__(self, other):
Georg Brandld7413152009-10-11 21:25:26 +0000511 return self.the_list == other.the_list
Serhiy Storchakadba90392016-05-10 12:01:23 +0300512
Georg Brandld7413152009-10-11 21:25:26 +0000513 def __hash__(self):
514 l = self.the_list
515 result = 98767 - len(l)*555
Georg Brandl99de4882009-12-20 14:24:06 +0000516 for i, el in enumerate(l):
Georg Brandld7413152009-10-11 21:25:26 +0000517 try:
Georg Brandl99de4882009-12-20 14:24:06 +0000518 result = result + (hash(el) % 9999999) * 1001 + i
519 except Exception:
Georg Brandld7413152009-10-11 21:25:26 +0000520 result = (result % 7777777) + i * 333
521 return result
522
523Note that the hash computation is complicated by the possibility that some
524members of the list may be unhashable and also by the possibility of arithmetic
525overflow.
526
Georg Brandl99de4882009-12-20 14:24:06 +0000527Furthermore it must always be the case that if ``o1 == o2`` (ie ``o1.__eq__(o2)
528is True``) then ``hash(o1) == hash(o2)`` (ie, ``o1.__hash__() == o2.__hash__()``),
Georg Brandld7413152009-10-11 21:25:26 +0000529regardless of whether the object is in a dictionary or not. If you fail to meet
530these restrictions dictionaries and other hash based structures will misbehave.
531
532In the case of ListWrapper, whenever the wrapper object is in a dictionary the
533wrapped list must not change to avoid anomalies. Don't do this unless you are
534prepared to think hard about the requirements and the consequences of not
535meeting them correctly. Consider yourself warned.
536
537
538Why doesn't list.sort() return the sorted list?
539-----------------------------------------------
540
541In situations where performance matters, making a copy of the list just to sort
542it would be wasteful. Therefore, :meth:`list.sort` sorts the list in place. In
543order to remind you of that fact, it does not return the sorted list. This way,
544you won't be fooled into accidentally overwriting a list when you need a sorted
545copy but also need to keep the unsorted version around.
546
Antoine Pitroudec0f212011-12-03 23:08:57 +0100547If you want to return a new list, use the built-in :func:`sorted` function
548instead. This function creates a new list from a provided iterable, sorts
549it and returns it. For example, here's how to iterate over the keys of a
550dictionary in sorted order::
Georg Brandld7413152009-10-11 21:25:26 +0000551
Georg Brandl99de4882009-12-20 14:24:06 +0000552 for key in sorted(mydict):
Serhiy Storchakadba90392016-05-10 12:01:23 +0300553 ... # do whatever with mydict[key]...
Georg Brandld7413152009-10-11 21:25:26 +0000554
555
556How do you specify and enforce an interface spec in Python?
557-----------------------------------------------------------
558
559An interface specification for a module as provided by languages such as C++ and
560Java describes the prototypes for the methods and functions of the module. Many
561feel that compile-time enforcement of interface specifications helps in the
562construction of large programs.
563
564Python 2.6 adds an :mod:`abc` module that lets you define Abstract Base Classes
565(ABCs). You can then use :func:`isinstance` and :func:`issubclass` to check
566whether an instance or a class implements a particular ABC. The
Éric Araujob8edbdf2011-09-01 05:57:12 +0200567:mod:`collections.abc` module defines a set of useful ABCs such as
Serhiy Storchakabfdcd432013-10-13 23:09:14 +0300568:class:`~collections.abc.Iterable`, :class:`~collections.abc.Container`, and
569:class:`~collections.abc.MutableMapping`.
Georg Brandld7413152009-10-11 21:25:26 +0000570
571For Python, many of the advantages of interface specifications can be obtained
572by an appropriate test discipline for components. There is also a tool,
573PyChecker, which can be used to find problems due to subclassing.
574
575A good test suite for a module can both provide a regression test and serve as a
576module interface specification and a set of examples. Many Python modules can
577be run as a script to provide a simple "self test." Even modules which use
578complex external interfaces can often be tested in isolation using trivial
579"stub" emulations of the external interface. The :mod:`doctest` and
580:mod:`unittest` modules or third-party test frameworks can be used to construct
581exhaustive test suites that exercise every line of code in a module.
582
583An appropriate testing discipline can help build large complex applications in
584Python as well as having interface specifications would. In fact, it can be
585better because an interface specification cannot test certain properties of a
586program. For example, the :meth:`append` method is expected to add new elements
587to the end of some internal list; an interface specification cannot test that
588your :meth:`append` implementation will actually do this correctly, but it's
589trivial to check this property in a test suite.
590
591Writing test suites is very helpful, and you might want to design your code with
592an eye to making it easily tested. One increasingly popular technique,
593test-directed development, calls for writing parts of the test suite first,
594before you write any of the actual code. Of course Python allows you to be
595sloppy and not write test cases at all.
596
597
Georg Brandld7413152009-10-11 21:25:26 +0000598Why is there no goto?
599---------------------
600
601You can use exceptions to provide a "structured goto" that even works across
602function calls. Many feel that exceptions can conveniently emulate all
603reasonable uses of the "go" or "goto" constructs of C, Fortran, and other
604languages. For example::
605
Ezio Melotti19cdee82013-01-05 06:53:27 +0200606 class label(Exception): pass # declare a label
Georg Brandld7413152009-10-11 21:25:26 +0000607
608 try:
Serhiy Storchakadba90392016-05-10 12:01:23 +0300609 ...
610 if condition: raise label() # goto label
611 ...
Georg Brandl99de4882009-12-20 14:24:06 +0000612 except label: # where to goto
Serhiy Storchakadba90392016-05-10 12:01:23 +0300613 pass
Georg Brandld7413152009-10-11 21:25:26 +0000614 ...
615
616This doesn't allow you to jump into the middle of a loop, but that's usually
617considered an abuse of goto anyway. Use sparingly.
618
619
620Why can't raw strings (r-strings) end with a backslash?
621-------------------------------------------------------
622
623More precisely, they can't end with an odd number of backslashes: the unpaired
624backslash at the end escapes the closing quote character, leaving an
625unterminated string.
626
627Raw strings were designed to ease creating input for processors (chiefly regular
628expression engines) that want to do their own backslash escape processing. Such
629processors consider an unmatched trailing backslash to be an error anyway, so
630raw strings disallow that. In return, they allow you to pass on the string
631quote character by escaping it with a backslash. These rules work well when
632r-strings are used for their intended purpose.
633
634If you're trying to build Windows pathnames, note that all Windows system calls
635accept forward slashes too::
636
Georg Brandl99de4882009-12-20 14:24:06 +0000637 f = open("/mydir/file.txt") # works fine!
Georg Brandld7413152009-10-11 21:25:26 +0000638
639If you're trying to build a pathname for a DOS command, try e.g. one of ::
640
641 dir = r"\this\is\my\dos\dir" "\\"
642 dir = r"\this\is\my\dos\dir\ "[:-1]
643 dir = "\\this\\is\\my\\dos\\dir\\"
644
645
646Why doesn't Python have a "with" statement for attribute assignments?
647---------------------------------------------------------------------
648
649Python has a 'with' statement that wraps the execution of a block, calling code
650on the entrance and exit from the block. Some language have a construct that
651looks like this::
652
653 with obj:
Benjamin Peterson1baf4652009-12-31 03:11:23 +0000654 a = 1 # equivalent to obj.a = 1
Georg Brandld7413152009-10-11 21:25:26 +0000655 total = total + 1 # obj.total = obj.total + 1
656
657In Python, such a construct would be ambiguous.
658
659Other languages, such as Object Pascal, Delphi, and C++, use static types, so
660it's possible to know, in an unambiguous way, what member is being assigned
661to. This is the main point of static typing -- the compiler *always* knows the
662scope of every variable at compile time.
663
664Python uses dynamic types. It is impossible to know in advance which attribute
665will be referenced at runtime. Member attributes may be added or removed from
666objects on the fly. This makes it impossible to know, from a simple reading,
667what attribute is being referenced: a local one, a global one, or a member
668attribute?
669
670For instance, take the following incomplete snippet::
671
672 def foo(a):
673 with a:
Georg Brandl99de4882009-12-20 14:24:06 +0000674 print(x)
Georg Brandld7413152009-10-11 21:25:26 +0000675
676The snippet assumes that "a" must have a member attribute called "x". However,
677there is nothing in Python that tells the interpreter this. What should happen
678if "a" is, let us say, an integer? If there is a global variable named "x",
679will it be used inside the with block? As you see, the dynamic nature of Python
680makes such choices much harder.
681
682The primary benefit of "with" and similar language features (reduction of code
683volume) can, however, easily be achieved in Python by assignment. Instead of::
684
Georg Brandl99de4882009-12-20 14:24:06 +0000685 function(args).mydict[index][index].a = 21
686 function(args).mydict[index][index].b = 42
687 function(args).mydict[index][index].c = 63
Georg Brandld7413152009-10-11 21:25:26 +0000688
689write this::
690
Georg Brandl99de4882009-12-20 14:24:06 +0000691 ref = function(args).mydict[index][index]
Georg Brandld7413152009-10-11 21:25:26 +0000692 ref.a = 21
693 ref.b = 42
694 ref.c = 63
695
696This also has the side-effect of increasing execution speed because name
697bindings are resolved at run-time in Python, and the second version only needs
Georg Brandl99de4882009-12-20 14:24:06 +0000698to perform the resolution once.
Georg Brandld7413152009-10-11 21:25:26 +0000699
700
701Why are colons required for the if/while/def/class statements?
702--------------------------------------------------------------
703
704The colon is required primarily to enhance readability (one of the results of
705the experimental ABC language). Consider this::
706
707 if a == b
Georg Brandl99de4882009-12-20 14:24:06 +0000708 print(a)
Georg Brandld7413152009-10-11 21:25:26 +0000709
710versus ::
711
712 if a == b:
Georg Brandl99de4882009-12-20 14:24:06 +0000713 print(a)
Georg Brandld7413152009-10-11 21:25:26 +0000714
715Notice how the second one is slightly easier to read. Notice further how a
716colon sets off the example in this FAQ answer; it's a standard usage in English.
717
718Another minor reason is that the colon makes it easier for editors with syntax
719highlighting; they can look for colons to decide when indentation needs to be
720increased instead of having to do a more elaborate parsing of the program text.
721
722
723Why does Python allow commas at the end of lists and tuples?
724------------------------------------------------------------
725
726Python lets you add a trailing comma at the end of lists, tuples, and
727dictionaries::
728
729 [1, 2, 3,]
730 ('a', 'b', 'c',)
731 d = {
732 "A": [1, 5],
733 "B": [6, 7], # last trailing comma is optional but good style
734 }
735
736
737There are several reasons to allow this.
738
739When you have a literal value for a list, tuple, or dictionary spread across
740multiple lines, it's easier to add more elements because you don't have to
Georg Brandl7b8c1322013-04-14 10:31:06 +0200741remember to add a comma to the previous line. The lines can also be reordered
742without creating a syntax error.
Georg Brandld7413152009-10-11 21:25:26 +0000743
744Accidentally omitting the comma can lead to errors that are hard to diagnose.
745For example::
746
747 x = [
748 "fee",
749 "fie"
750 "foo",
751 "fum"
752 ]
753
754This list looks like it has four elements, but it actually contains three:
755"fee", "fiefoo" and "fum". Always adding the comma avoids this source of error.
756
757Allowing the trailing comma may also make programmatic code generation easier.