1====================== 2Design and History FAQ 3====================== 4 5.. only:: html 6 7 .. contents:: 8 9 10Why 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. 15Most people learn to love this feature after a while. 16 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 36Many coding styles place begin/end brackets on a line by themselves. This makes 37programs 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 39screen (say, 20--30 lines). 20 lines of Python can do a lot more work than 20 40lines 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 51Why are floating-point calculations so inaccurate? 52-------------------------------------------------- 53 54Users are often surprised by results like this:: 55 56 >>> 1.2 - 1.0 57 0.19999999999999996 58 59and 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. 62 63The :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. 69 70Many numbers that can be written easily in decimal notation cannot be expressed 71exactly in binary floating-point. For example, after:: 72 73 >>> x = 1.2 74 75the 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:: 78 79 1.0011001100110011001100110011001100110011001100110011 (binary) 80 81which is exactly:: 82 83 1.1999999999999999555910790149937383830547332763671875 (decimal) 84 85The typical precision of 53 bits provides Python floats with 15--16 86decimal digits of accuracy. 87 88For a fuller explanation, please see the :ref:`floating point arithmetic 89<tut-fp-issues>` chapter in the Python tutorial. 90 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 128to 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. 133 134Finally, for instance variables it solves a syntactic problem with assignment: 135since local variables in Python are (by definition!) those variables to which a 136value 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 140declarations, but Python doesn't have declarations and it would be a pity having 141to introduce them just for this purpose. Using the explicit ``self.var`` solves 142this nicely. Similarly, for using instance variables, having to write 143``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. 147 148 149Why can't I use an assignment in an expression? 150----------------------------------------------- 151 152Many people used to C or Perl complain that they want to use this C idiom: 153 154.. code-block:: c 155 156 while (line = readline(f)) { 157 // do something with line 158 } 159 160where in Python you're forced to write this:: 161 162 while True: 163 line = f.readline() 164 if not line: 165 break 166 ... # do something with line 167 168The reason for not allowing assignment in Python expressions is a common, 169hard-to-find bug in those other languages, caused by this construct: 170 171.. code-block:: c 172 173 if (x = 0) { 174 // error handling 175 } 176 else { 177 // code that only works for nonzero x 178 } 179 180The error is a simple typo: ``x = 0``, which assigns 0 to the variable ``x``, 181was written while the comparison ``x == 0`` is certainly what was intended. 182 183Many alternatives have been proposed. Most are hacks that save some typing but 184use arbitrary or cryptic syntax or keywords, and fail the simple criterion for 185language change proposals: it should intuitively suggest the proper meaning to a 186human reader who has not yet been introduced to the construct. 187 188An interesting phenomenon is that most experienced Python programmers recognize 189the ``while True`` idiom and don't seem to be missing the assignment in 190expression construct much; it's only newcomers who express a strong desire to 191add this to the language. 192 193There's an alternative way of spelling this that seems attractive but is 194generally less robust than the "while True" solution:: 195 196 line = f.readline() 197 while line: 198 ... # do something with line... 199 line = f.readline() 200 201The problem with this is that if you change your mind about exactly how you get 202the next line (e.g. you want to change it into ``sys.stdin.readline()``) you 203have to remember to change two places in your program -- the second occurrence 204is hidden at the bottom of the loop. 205 206The best approach is to use iterators, making it possible to loop through 207objects using the ``for`` statement. For example, :term:`file objects 208<file object>` support the iterator protocol, so you can write simply:: 209 210 for line in f: 211 ... # do something with line... 212 213 214 215Why does Python use methods for some functionality (e.g. list.index()) but functions for other (e.g. len(list))? 216---------------------------------------------------------------------------------------------------------------- 217 218As Guido said: 219 220 (a) For some operations, prefix notation just reads better than 221 postfix -- prefix (and infix!) operations have a long tradition in 222 mathematics which likes notations where the visuals help the 223 mathematician thinking about a problem. Compare the easy with which we 224 rewrite a formula like x*(a+b) into x*a + x*b to the clumsiness of 225 doing the same thing using a raw OO notation. 226 227 (b) When I read code that says len(x) I *know* that it is asking for 228 the length of something. This tells me two things: the result is an 229 integer, and the argument is some kind of container. To the contrary, 230 when I read x.len(), I have to already know that x is some kind of 231 container implementing an interface or inheriting from a class that 232 has a standard len(). Witness the confusion we occasionally have when 233 a class that is not implementing a mapping has a get() or keys() 234 method, or something that isn't a file has a write() method. 235 236 -- https://mail.python.org/pipermail/python-3000/2006-November/004643.html 237 238 239Why is join() a string method instead of a list or tuple method? 240---------------------------------------------------------------- 241 242Strings became much more like other standard types starting in Python 1.6, when 243methods were added which give the same functionality that has always been 244available using the functions of the string module. Most of these new methods 245have been widely accepted, but the one which appears to make some programmers 246feel uncomfortable is:: 247 248 ", ".join(['1', '2', '4', '8', '16']) 249 250which gives the result:: 251 252 "1, 2, 4, 8, 16" 253 254There are two common arguments against this usage. 255 256The first runs along the lines of: "It looks really ugly using a method of a 257string literal (string constant)", to which the answer is that it might, but a 258string literal is just a fixed value. If the methods are to be allowed on names 259bound to strings there is no logical reason to make them unavailable on 260literals. 261 262The second objection is typically cast as: "I am really telling a sequence to 263join its members together with a string constant". Sadly, you aren't. For some 264reason there seems to be much less difficulty with having :meth:`~str.split` as 265a string method, since in that case it is easy to see that :: 266 267 "1, 2, 4, 8, 16".split(", ") 268 269is an instruction to a string literal to return the substrings delimited by the 270given separator (or, by default, arbitrary runs of white space). 271 272:meth:`~str.join` is a string method because in using it you are telling the 273separator string to iterate over a sequence of strings and insert itself between 274adjacent elements. This method can be used with any argument which obeys the 275rules for sequence objects, including any new classes you might define yourself. 276Similar methods exist for bytes and bytearray objects. 277 278 279How fast are exceptions? 280------------------------ 281 282A try/except block is extremely efficient if no exceptions are raised. Actually 283catching an exception is expensive. In versions of Python prior to 2.0 it was 284common to use this idiom:: 285 286 try: 287 value = mydict[key] 288 except KeyError: 289 mydict[key] = getvalue(key) 290 value = mydict[key] 291 292This only made sense when you expected the dict to have the key almost all the 293time. If that wasn't the case, you coded it like this:: 294 295 if key in mydict: 296 value = mydict[key] 297 else: 298 value = mydict[key] = getvalue(key) 299 300For this specific case, you could also use ``value = dict.setdefault(key, 301getvalue(key))``, but only if the ``getvalue()`` call is cheap enough because it 302is evaluated in all cases. 303 304 305Why isn't there a switch or case statement in Python? 306----------------------------------------------------- 307 308You can do this easily enough with a sequence of ``if... elif... elif... else``. 309There have been some proposals for switch statement syntax, but there is no 310consensus (yet) on whether and how to do range tests. See :pep:`275` for 311complete details and the current status. 312 313For cases where you need to choose from a very large number of possibilities, 314you can create a dictionary mapping case values to functions to call. For 315example:: 316 317 def function_1(...): 318 ... 319 320 functions = {'a': function_1, 321 'b': function_2, 322 'c': self.method_1, ...} 323 324 func = functions[value] 325 func() 326 327For calling methods on objects, you can simplify yet further by using the 328:func:`getattr` built-in to retrieve methods with a particular name:: 329 330 def visit_a(self, ...): 331 ... 332 ... 333 334 def dispatch(self, value): 335 method_name = 'visit_' + str(value) 336 method = getattr(self, method_name) 337 method() 338 339It's suggested that you use a prefix for the method names, such as ``visit_`` in 340this example. Without such a prefix, if values are coming from an untrusted 341source, an attacker would be able to call any method on your object. 342 343 344Can't you emulate threads in the interpreter instead of relying on an OS-specific thread implementation? 345-------------------------------------------------------------------------------------------------------- 346 347Answer 1: Unfortunately, the interpreter pushes at least one C stack frame for 348each Python stack frame. Also, extensions can call back into Python at almost 349random moments. Therefore, a complete threads implementation requires thread 350support for C. 351 352Answer 2: Fortunately, there is `Stackless Python <https://github.com/stackless-dev/stackless/wiki>`_, 353which has a completely redesigned interpreter loop that avoids the C stack. 354 355 356Why can't lambda expressions contain statements? 357------------------------------------------------ 358 359Python lambda expressions cannot contain statements because Python's syntactic 360framework can't handle statements nested inside expressions. However, in 361Python, this is not a serious problem. Unlike lambda forms in other languages, 362where they add functionality, Python lambdas are only a shorthand notation if 363you're too lazy to define a function. 364 365Functions are already first class objects in Python, and can be declared in a 366local scope. Therefore the only advantage of using a lambda instead of a 367locally-defined function is that you don't need to invent a name for the 368function -- but that's just a local variable to which the function object (which 369is exactly the same type of object that a lambda expression yields) is assigned! 370 371 372Can Python be compiled to machine code, C or some other language? 373----------------------------------------------------------------- 374 375`Cython <http://cython.org/>`_ compiles a modified version of Python with 376optional annotations into C extensions. `Nuitka <http://www.nuitka.net/>`_ is 377an up-and-coming compiler of Python into C++ code, aiming to support the full 378Python language. For compiling to Java you can consider 379`VOC <https://voc.readthedocs.io>`_. 380 381 382How does Python manage memory? 383------------------------------ 384 385The details of Python memory management depend on the implementation. The 386standard implementation of Python, :term:`CPython`, uses reference counting to 387detect inaccessible objects, and another mechanism to collect reference cycles, 388periodically executing a cycle detection algorithm which looks for inaccessible 389cycles and deletes the objects involved. The :mod:`gc` module provides functions 390to perform a garbage collection, obtain debugging statistics, and tune the 391collector's parameters. 392 393Other implementations (such as `Jython <http://www.jython.org>`_ or 394`PyPy <http://www.pypy.org>`_), however, can rely on a different mechanism 395such as a full-blown garbage collector. This difference can cause some 396subtle porting problems if your Python code depends on the behavior of the 397reference counting implementation. 398 399In some Python implementations, the following code (which is fine in CPython) 400will probably run out of file descriptors:: 401 402 for file in very_long_list_of_files: 403 f = open(file) 404 c = f.read(1) 405 406Indeed, using CPython's reference counting and destructor scheme, each new 407assignment to *f* closes the previous file. With a traditional GC, however, 408those file objects will only get collected (and closed) at varying and possibly 409long intervals. 410 411If you want to write code that will work with any Python implementation, 412you should explicitly close the file or use the :keyword:`with` statement; 413this will work regardless of memory management scheme:: 414 415 for file in very_long_list_of_files: 416 with open(file) as f: 417 c = f.read(1) 418 419 420Why doesn't CPython use a more traditional garbage collection scheme? 421--------------------------------------------------------------------- 422 423For one thing, this is not a C standard feature and hence it's not portable. 424(Yes, we know about the Boehm GC library. It has bits of assembler code for 425*most* common platforms, not for all of them, and although it is mostly 426transparent, it isn't completely transparent; patches are required to get 427Python to work with it.) 428 429Traditional GC also becomes a problem when Python is embedded into other 430applications. While in a standalone Python it's fine to replace the standard 431malloc() and free() with versions provided by the GC library, an application 432embedding Python may want to have its *own* substitute for malloc() and free(), 433and may not want Python's. Right now, CPython works with anything that 434implements malloc() and free() properly. 435 436 437Why isn't all memory freed when CPython exits? 438---------------------------------------------- 439 440Objects referenced from the global namespaces of Python modules are not always 441deallocated when Python exits. This may happen if there are circular 442references. There are also certain bits of memory that are allocated by the C 443library that are impossible to free (e.g. a tool like Purify will complain about 444these). Python is, however, aggressive about cleaning up memory on exit and 445does try to destroy every single object. 446 447If you want to force Python to delete certain things on deallocation use the 448:mod:`atexit` module to run a function that will force those deletions. 449 450 451Why are there separate tuple and list data types? 452------------------------------------------------- 453 454Lists and tuples, while similar in many respects, are generally used in 455fundamentally different ways. Tuples can be thought of as being similar to 456Pascal records or C structs; they're small collections of related data which may 457be of different types which are operated on as a group. For example, a 458Cartesian coordinate is appropriately represented as a tuple of two or three 459numbers. 460 461Lists, on the other hand, are more like arrays in other languages. They tend to 462hold a varying number of objects all of which have the same type and which are 463operated on one-by-one. For example, ``os.listdir('.')`` returns a list of 464strings representing the files in the current directory. Functions which 465operate on this output would generally not break if you added another file or 466two to the directory. 467 468Tuples are immutable, meaning that once a tuple has been created, you can't 469replace any of its elements with a new value. Lists are mutable, meaning that 470you can always change a list's elements. Only immutable elements can be used as 471dictionary keys, and hence only tuples and not lists can be used as keys. 472 473 474How are lists implemented in CPython? 475------------------------------------- 476 477CPython's lists are really variable-length arrays, not Lisp-style linked lists. 478The implementation uses a contiguous array of references to other objects, and 479keeps a pointer to this array and the array's length in a list head structure. 480 481This makes indexing a list ``a[i]`` an operation whose cost is independent of 482the size of the list or the value of the index. 483 484When items are appended or inserted, the array of references is resized. Some 485cleverness is applied to improve the performance of appending items repeatedly; 486when the array must be grown, some extra space is allocated so the next few 487times don't require an actual resize. 488 489 490How are dictionaries implemented in CPython? 491-------------------------------------------- 492 493CPython's dictionaries are implemented as resizable hash tables. Compared to 494B-trees, this gives better performance for lookup (the most common operation by 495far) under most circumstances, and the implementation is simpler. 496 497Dictionaries work by computing a hash code for each key stored in the dictionary 498using the :func:`hash` built-in function. The hash code varies widely depending 499on the key and a per-process seed; for example, "Python" could hash to 500-539294296 while "python", a string that differs by a single bit, could hash 501to 1142331976. The hash code is then used to calculate a location in an 502internal array where the value will be stored. Assuming that you're storing 503keys that all have different hash values, this means that dictionaries take 504constant time -- O(1), in Big-O notation -- to retrieve a key. 505 506 507Why must dictionary keys be immutable? 508-------------------------------------- 509 510The hash table implementation of dictionaries uses a hash value calculated from 511the key value to find the key. If the key were a mutable object, its value 512could change, and thus its hash could also change. But since whoever changes 513the key object can't tell that it was being used as a dictionary key, it can't 514move the entry around in the dictionary. Then, when you try to look up the same 515object in the dictionary it won't be found because its hash value is different. 516If you tried to look up the old value it wouldn't be found either, because the 517value of the object found in that hash bin would be different. 518 519If you want a dictionary indexed with a list, simply convert the list to a tuple 520first; the function ``tuple(L)`` creates a tuple with the same entries as the 521list ``L``. Tuples are immutable and can therefore be used as dictionary keys. 522 523Some unacceptable solutions that have been proposed: 524 525- Hash lists by their address (object ID). This doesn't work because if you 526 construct a new list with the same value it won't be found; e.g.:: 527 528 mydict = {[1, 2]: '12'} 529 print(mydict[[1, 2]]) 530 531 would raise a :exc:`KeyError` exception because the id of the ``[1, 2]`` used in the 532 second line differs from that in the first line. In other words, dictionary 533 keys should be compared using ``==``, not using :keyword:`is`. 534 535- Make a copy when using a list as a key. This doesn't work because the list, 536 being a mutable object, could contain a reference to itself, and then the 537 copying code would run into an infinite loop. 538 539- Allow lists as keys but tell the user not to modify them. This would allow a 540 class of hard-to-track bugs in programs when you forgot or modified a list by 541 accident. It also invalidates an important invariant of dictionaries: every 542 value in ``d.keys()`` is usable as a key of the dictionary. 543 544- Mark lists as read-only once they are used as a dictionary key. The problem 545 is that it's not just the top-level object that could change its value; you 546 could use a tuple containing a list as a key. Entering anything as a key into 547 a dictionary would require marking all objects reachable from there as 548 read-only -- and again, self-referential objects could cause an infinite loop. 549 550There is a trick to get around this if you need to, but use it at your own risk: 551You can wrap a mutable structure inside a class instance which has both a 552:meth:`__eq__` and a :meth:`__hash__` method. You must then make sure that the 553hash value for all such wrapper objects that reside in a dictionary (or other 554hash based structure), remain fixed while the object is in the dictionary (or 555other structure). :: 556 557 class ListWrapper: 558 def __init__(self, the_list): 559 self.the_list = the_list 560 561 def __eq__(self, other): 562 return self.the_list == other.the_list 563 564 def __hash__(self): 565 l = self.the_list 566 result = 98767 - len(l)*555 567 for i, el in enumerate(l): 568 try: 569 result = result + (hash(el) % 9999999) * 1001 + i 570 except Exception: 571 result = (result % 7777777) + i * 333 572 return result 573 574Note that the hash computation is complicated by the possibility that some 575members of the list may be unhashable and also by the possibility of arithmetic 576overflow. 577 578Furthermore it must always be the case that if ``o1 == o2`` (ie ``o1.__eq__(o2) 579is True``) then ``hash(o1) == hash(o2)`` (ie, ``o1.__hash__() == o2.__hash__()``), 580regardless of whether the object is in a dictionary or not. If you fail to meet 581these restrictions dictionaries and other hash based structures will misbehave. 582 583In the case of ListWrapper, whenever the wrapper object is in a dictionary the 584wrapped list must not change to avoid anomalies. Don't do this unless you are 585prepared to think hard about the requirements and the consequences of not 586meeting them correctly. Consider yourself warned. 587 588 589Why doesn't list.sort() return the sorted list? 590----------------------------------------------- 591 592In situations where performance matters, making a copy of the list just to sort 593it would be wasteful. Therefore, :meth:`list.sort` sorts the list in place. In 594order to remind you of that fact, it does not return the sorted list. This way, 595you won't be fooled into accidentally overwriting a list when you need a sorted 596copy but also need to keep the unsorted version around. 597 598If you want to return a new list, use the built-in :func:`sorted` function 599instead. This function creates a new list from a provided iterable, sorts 600it and returns it. For example, here's how to iterate over the keys of a 601dictionary in sorted order:: 602 603 for key in sorted(mydict): 604 ... # do whatever with mydict[key]... 605 606 607How do you specify and enforce an interface spec in Python? 608----------------------------------------------------------- 609 610An interface specification for a module as provided by languages such as C++ and 611Java describes the prototypes for the methods and functions of the module. Many 612feel that compile-time enforcement of interface specifications helps in the 613construction of large programs. 614 615Python 2.6 adds an :mod:`abc` module that lets you define Abstract Base Classes 616(ABCs). You can then use :func:`isinstance` and :func:`issubclass` to check 617whether an instance or a class implements a particular ABC. The 618:mod:`collections.abc` module defines a set of useful ABCs such as 619:class:`~collections.abc.Iterable`, :class:`~collections.abc.Container`, and 620:class:`~collections.abc.MutableMapping`. 621 622For Python, many of the advantages of interface specifications can be obtained 623by an appropriate test discipline for components. There is also a tool, 624PyChecker, which can be used to find problems due to subclassing. 625 626A good test suite for a module can both provide a regression test and serve as a 627module interface specification and a set of examples. Many Python modules can 628be run as a script to provide a simple "self test." Even modules which use 629complex external interfaces can often be tested in isolation using trivial 630"stub" emulations of the external interface. The :mod:`doctest` and 631:mod:`unittest` modules or third-party test frameworks can be used to construct 632exhaustive test suites that exercise every line of code in a module. 633 634An appropriate testing discipline can help build large complex applications in 635Python as well as having interface specifications would. In fact, it can be 636better because an interface specification cannot test certain properties of a 637program. For example, the :meth:`append` method is expected to add new elements 638to the end of some internal list; an interface specification cannot test that 639your :meth:`append` implementation will actually do this correctly, but it's 640trivial to check this property in a test suite. 641 642Writing test suites is very helpful, and you might want to design your code with 643an eye to making it easily tested. One increasingly popular technique, 644test-directed development, calls for writing parts of the test suite first, 645before you write any of the actual code. Of course Python allows you to be 646sloppy and not write test cases at all. 647 648 649Why is there no goto? 650--------------------- 651 652You can use exceptions to provide a "structured goto" that even works across 653function calls. Many feel that exceptions can conveniently emulate all 654reasonable uses of the "go" or "goto" constructs of C, Fortran, and other 655languages. For example:: 656 657 class label(Exception): pass # declare a label 658 659 try: 660 ... 661 if condition: raise label() # goto label 662 ... 663 except label: # where to goto 664 pass 665 ... 666 667This doesn't allow you to jump into the middle of a loop, but that's usually 668considered an abuse of goto anyway. Use sparingly. 669 670 671Why can't raw strings (r-strings) end with a backslash? 672------------------------------------------------------- 673 674More precisely, they can't end with an odd number of backslashes: the unpaired 675backslash at the end escapes the closing quote character, leaving an 676unterminated string. 677 678Raw strings were designed to ease creating input for processors (chiefly regular 679expression engines) that want to do their own backslash escape processing. Such 680processors consider an unmatched trailing backslash to be an error anyway, so 681raw strings disallow that. In return, they allow you to pass on the string 682quote character by escaping it with a backslash. These rules work well when 683r-strings are used for their intended purpose. 684 685If you're trying to build Windows pathnames, note that all Windows system calls 686accept forward slashes too:: 687 688 f = open("/mydir/file.txt") # works fine! 689 690If you're trying to build a pathname for a DOS command, try e.g. one of :: 691 692 dir = r"\this\is\my\dos\dir" "\\" 693 dir = r"\this\is\my\dos\dir\ "[:-1] 694 dir = "\\this\\is\\my\\dos\\dir\\" 695 696 697Why doesn't Python have a "with" statement for attribute assignments? 698--------------------------------------------------------------------- 699 700Python has a 'with' statement that wraps the execution of a block, calling code 701on the entrance and exit from the block. Some language have a construct that 702looks like this:: 703 704 with obj: 705 a = 1 # equivalent to obj.a = 1 706 total = total + 1 # obj.total = obj.total + 1 707 708In Python, such a construct would be ambiguous. 709 710Other languages, such as Object Pascal, Delphi, and C++, use static types, so 711it's possible to know, in an unambiguous way, what member is being assigned 712to. This is the main point of static typing -- the compiler *always* knows the 713scope of every variable at compile time. 714 715Python uses dynamic types. It is impossible to know in advance which attribute 716will be referenced at runtime. Member attributes may be added or removed from 717objects on the fly. This makes it impossible to know, from a simple reading, 718what attribute is being referenced: a local one, a global one, or a member 719attribute? 720 721For instance, take the following incomplete snippet:: 722 723 def foo(a): 724 with a: 725 print(x) 726 727The snippet assumes that "a" must have a member attribute called "x". However, 728there is nothing in Python that tells the interpreter this. What should happen 729if "a" is, let us say, an integer? If there is a global variable named "x", 730will it be used inside the with block? As you see, the dynamic nature of Python 731makes such choices much harder. 732 733The primary benefit of "with" and similar language features (reduction of code 734volume) can, however, easily be achieved in Python by assignment. Instead of:: 735 736 function(args).mydict[index][index].a = 21 737 function(args).mydict[index][index].b = 42 738 function(args).mydict[index][index].c = 63 739 740write this:: 741 742 ref = function(args).mydict[index][index] 743 ref.a = 21 744 ref.b = 42 745 ref.c = 63 746 747This also has the side-effect of increasing execution speed because name 748bindings are resolved at run-time in Python, and the second version only needs 749to perform the resolution once. 750 751 752Why are colons required for the if/while/def/class statements? 753-------------------------------------------------------------- 754 755The colon is required primarily to enhance readability (one of the results of 756the experimental ABC language). Consider this:: 757 758 if a == b 759 print(a) 760 761versus :: 762 763 if a == b: 764 print(a) 765 766Notice how the second one is slightly easier to read. Notice further how a 767colon sets off the example in this FAQ answer; it's a standard usage in English. 768 769Another minor reason is that the colon makes it easier for editors with syntax 770highlighting; they can look for colons to decide when indentation needs to be 771increased instead of having to do a more elaborate parsing of the program text. 772 773 774Why does Python allow commas at the end of lists and tuples? 775------------------------------------------------------------ 776 777Python lets you add a trailing comma at the end of lists, tuples, and 778dictionaries:: 779 780 [1, 2, 3,] 781 ('a', 'b', 'c',) 782 d = { 783 "A": [1, 5], 784 "B": [6, 7], # last trailing comma is optional but good style 785 } 786 787 788There are several reasons to allow this. 789 790When you have a literal value for a list, tuple, or dictionary spread across 791multiple lines, it's easier to add more elements because you don't have to 792remember to add a comma to the previous line. The lines can also be reordered 793without creating a syntax error. 794 795Accidentally omitting the comma can lead to errors that are hard to diagnose. 796For example:: 797 798 x = [ 799 "fee", 800 "fie" 801 "foo", 802 "fum" 803 ] 804 805This list looks like it has four elements, but it actually contains three: 806"fee", "fiefoo" and "fum". Always adding the comma avoids this source of error. 807 808Allowing the trailing comma may also make programmatic code generation easier. 809