diff options
Diffstat (limited to 'Doc')
63 files changed, 449 insertions, 413 deletions
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst index 7d6a84e..0672253 100644 --- a/Doc/distutils/apiref.rst +++ b/Doc/distutils/apiref.rst @@ -1907,9 +1907,9 @@ Subclasses of :class:`Command` must define the following methods. that is designed to run with both Python 2.x and 3.x, add:: try: - from distutils.command.build_py import build_py_2to3 as build_py + from distutils.command.build_py import build_py_2to3 as build_py except ImportError: - from distutils.command.build_py import build_py + from distutils.command.build_py import build_py to your setup.py, and later:: diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst index c42cccb..1b6cd7e 100644 --- a/Doc/faq/design.rst +++ b/Doc/faq/design.rst @@ -158,7 +158,7 @@ where in Python you're forced to write this:: line = f.readline() if not line: break - ... # do something with line + ... # do something with line The reason for not allowing assignment in Python expressions is a common, hard-to-find bug in those other languages, caused by this construct: @@ -190,7 +190,7 @@ generally less robust than the "while True" solution:: line = f.readline() while line: - ... # do something with line... + ... # do something with line... line = f.readline() The problem with this is that if you change your mind about exactly how you get @@ -203,7 +203,7 @@ objects using the ``for`` statement. For example, :term:`file objects <file object>` support the iterator protocol, so you can write simply:: for line in f: - ... # do something with line... + ... # do something with line... @@ -577,8 +577,10 @@ other structure). :: class ListWrapper: def __init__(self, the_list): self.the_list = the_list + def __eq__(self, other): return self.the_list == other.the_list + def __hash__(self): l = self.the_list result = 98767 - len(l)*555 @@ -619,7 +621,7 @@ it and returns it. For example, here's how to iterate over the keys of a dictionary in sorted order:: for key in sorted(mydict): - ... # do whatever with mydict[key]... + ... # do whatever with mydict[key]... How do you specify and enforce an interface spec in Python? @@ -675,11 +677,11 @@ languages. For example:: class label(Exception): pass # declare a label try: - ... - if condition: raise label() # goto label - ... + ... + if condition: raise label() # goto label + ... except label: # where to goto - pass + pass ... This doesn't allow you to jump into the middle of a loop, but that's usually diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst index 2f82a0c..b5fdfa4 100644 --- a/Doc/faq/library.rst +++ b/Doc/faq/library.rst @@ -257,7 +257,8 @@ all the threads to finish:: import threading, time def thread_task(name, n): - for i in range(n): print(name, i) + for i in range(n): + print(name, i) for i in range(10): T = threading.Thread(target=thread_task, args=(str(i), i)) @@ -273,7 +274,8 @@ A simple fix is to add a tiny sleep to the start of the run function:: def thread_task(name, n): time.sleep(0.001) # <--------------------! - for i in range(n): print(name, i) + for i in range(n): + print(name, i) for i in range(10): T = threading.Thread(target=thread_task, args=(str(i), i)) @@ -502,8 +504,8 @@ in big-endian format from a file:: import struct with open(filename, "rb") as f: - s = f.read(8) - x, y, z = struct.unpack(">hhl", s) + s = f.read(8) + x, y, z = struct.unpack(">hhl", s) The '>' in the format string forces big-endian data; the letter 'h' reads one "short integer" (2 bytes), and 'l' reads one "long integer" (4 bytes) from the @@ -681,10 +683,10 @@ Yes. Here's a simple example that uses urllib.request:: import urllib.request - ### build the query string + # build the query string qs = "First=Josephine&MI=Q&Last=Public" - ### connect and send the server a path + # connect and send the server a path req = urllib.request.urlopen('http://www.some-server.out-there' '/cgi-bin/some-cgi-script', data=qs) with req: @@ -740,8 +742,9 @@ varies between systems; sometimes it is ``/usr/lib/sendmail``, sometimes ``/usr/sbin/sendmail``. The sendmail manual page will help you out. Here's some sample code:: - SENDMAIL = "/usr/sbin/sendmail" # sendmail location import os + + SENDMAIL = "/usr/sbin/sendmail" # sendmail location p = os.popen("%s -t -i" % SENDMAIL, "w") p.write("To: receiver@example.com\n") p.write("Subject: test\n") diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index 355dfd2..9dd3a72 100644 --- a/Doc/faq/programming.rst +++ b/Doc/faq/programming.rst @@ -207,7 +207,7 @@ functions), e.g.:: >>> squares = [] >>> for x in range(5): - ... squares.append(lambda: x**2) + ... squares.append(lambda: x**2) This gives you a list that contains 5 lambdas that calculate ``x**2``. You might expect that, when called, they would return, respectively, ``0``, ``1``, @@ -234,7 +234,7 @@ lambdas, so that they don't rely on the value of the global ``x``:: >>> squares = [] >>> for x in range(5): - ... squares.append(lambda n=x: n**2) + ... squares.append(lambda n=x: n**2) Here, ``n=x`` creates a new variable ``n`` local to the lambda and computed when the lambda is defined so that it has the same value that ``x`` had at @@ -539,7 +539,7 @@ desired effect in a number of ways. args['a'] = 'new-value' # args is a mutable dictionary args['b'] = args['b'] + 1 # change it in-place - args = {'a':' old-value', 'b': 99} + args = {'a': 'old-value', 'b': 99} func3(args) print(args['a'], args['b']) @@ -655,16 +655,15 @@ Essentially, assignment always binds a name to a value; The same is true of ``def`` and ``class`` statements, but in that case the value is a callable. Consider the following code:: - class A: - pass - - B = A - - a = B() - b = a - print(b) + >>> class A: + ... pass + ... + >>> B = A + >>> a = B() + >>> b = a + >>> print(b) <__main__.A object at 0x16D07CC> - print(a) + >>> print(a) <__main__.A object at 0x16D07CC> Arguably the class has a name: even though it is bound to two names and invoked @@ -1100,7 +1099,7 @@ How do I iterate over a sequence in reverse order? Use the :func:`reversed` built-in function, which is new in Python 2.4:: for x in reversed(sequence): - ... # do something with x... + ... # do something with x ... This won't touch your original sequence, but build a new copy with reversed order to iterate over. @@ -1108,7 +1107,7 @@ order to iterate over. With Python 2.3, you can use an extended slice syntax:: for x in sequence[::-1]: - ... # do something with x... + ... # do something with x ... How do you remove duplicates from a list? @@ -1406,7 +1405,7 @@ A method is a function on some object ``x`` that you normally call as definition:: class C: - def meth (self, arg): + def meth(self, arg): return arg * 2 + self.attribute @@ -1439,9 +1438,9 @@ that does something:: def search(obj): if isinstance(obj, Mailbox): - # ... code to search a mailbox + ... # code to search a mailbox elif isinstance(obj, Document): - # ... code to search a document + ... # code to search a document elif ... A better approach is to define a ``search()`` method on all the classes and just @@ -1449,11 +1448,11 @@ call it:: class Mailbox: def search(self): - # ... code to search a mailbox + ... # code to search a mailbox class Document: def search(self): - # ... code to search a document + ... # code to search a document obj.search() @@ -1510,7 +1509,7 @@ How do I call a method defined in a base class from a derived class that overrid Use the built-in :func:`super` function:: class Derived(Base): - def meth (self): + def meth(self): super(Derived, self).meth() For version prior to 3.0, you may be using classic classes: For a class diff --git a/Doc/howto/descriptor.rst b/Doc/howto/descriptor.rst index 530f34b..d370eb5 100644 --- a/Doc/howto/descriptor.rst +++ b/Doc/howto/descriptor.rst @@ -104,7 +104,7 @@ like:: "Emulate type_getattro() in Objects/typeobject.c" v = object.__getattribute__(self, key) if hasattr(v, '__get__'): - return v.__get__(None, self) + return v.__get__(None, self) return v The important points to remember are: @@ -163,9 +163,9 @@ descriptor is useful for monitoring just a few chosen attributes:: self.val = val >>> class MyClass(object): - x = RevealAccess(10, 'var "x"') - y = 5 - + ... x = RevealAccess(10, 'var "x"') + ... y = 5 + ... >>> m = MyClass() >>> m.x Retrieving var "x" @@ -287,15 +287,15 @@ this:: Running the interpreter shows how the function descriptor works in practice:: >>> class D(object): - def f(self, x): - return x - + ... def f(self, x): + ... return x + ... >>> d = D() - >>> D.__dict__['f'] # Stored internally as a function + >>> D.__dict__['f'] # Stored internally as a function <function f at 0x00C45070> - >>> D.f # Get from a class becomes an unbound method + >>> D.f # Get from a class becomes an unbound method <unbound method D.f> - >>> d.f # Get from an instance becomes a bound method + >>> d.f # Get from an instance becomes a bound method <bound method D.f of <__main__.D object at 0x00B18C90>> The output suggests that bound and unbound methods are two different types. @@ -358,10 +358,10 @@ Since staticmethods return the underlying function with no changes, the example calls are unexciting:: >>> class E(object): - def f(x): - print(x) - f = staticmethod(f) - + ... def f(x): + ... print(x) + ... f = staticmethod(f) + ... >>> print(E.f(3)) 3 >>> print(E().f(3)) @@ -371,23 +371,23 @@ Using the non-data descriptor protocol, a pure Python version of :func:`staticmethod` would look like this:: class StaticMethod(object): - "Emulate PyStaticMethod_Type() in Objects/funcobject.c" + "Emulate PyStaticMethod_Type() in Objects/funcobject.c" - def __init__(self, f): - self.f = f + def __init__(self, f): + self.f = f - def __get__(self, obj, objtype=None): - return self.f + def __get__(self, obj, objtype=None): + return self.f Unlike static methods, class methods prepend the class reference to the argument list before calling the function. This format is the same for whether the caller is an object or a class:: >>> class E(object): - def f(klass, x): - return klass.__name__, x - f = classmethod(f) - + ... def f(klass, x): + ... return klass.__name__, x + ... f = classmethod(f) + ... >>> print(E.f(3)) ('E', 3) >>> print(E().f(3)) @@ -419,15 +419,15 @@ Using the non-data descriptor protocol, a pure Python version of :func:`classmethod` would look like this:: class ClassMethod(object): - "Emulate PyClassMethod_Type() in Objects/funcobject.c" + "Emulate PyClassMethod_Type() in Objects/funcobject.c" - def __init__(self, f): - self.f = f + def __init__(self, f): + self.f = f - def __get__(self, obj, klass=None): - if klass is None: - klass = type(obj) - def newfunc(*args): - return self.f(klass, *args) - return newfunc + def __get__(self, obj, klass=None): + if klass is None: + klass = type(obj) + def newfunc(*args): + return self.f(klass, *args) + return newfunc diff --git a/Doc/howto/functional.rst b/Doc/howto/functional.rst index 80ff710..6e21f93 100644 --- a/Doc/howto/functional.rst +++ b/Doc/howto/functional.rst @@ -395,14 +395,14 @@ equivalent to the following Python code:: continue # Skip this element for expr2 in sequence2: if not (condition2): - continue # Skip this element + continue # Skip this element ... for exprN in sequenceN: - if not (conditionN): - continue # Skip this element + if not (conditionN): + continue # Skip this element - # Output the value of - # the expression. + # Output the value of + # the expression. This means that when there are multiple ``for...in`` clauses but no ``if`` clauses, the length of the resulting output will be equal to the product of the diff --git a/Doc/howto/logging-cookbook.rst b/Doc/howto/logging-cookbook.rst index e784acc..99b4cdc 100644 --- a/Doc/howto/logging-cookbook.rst +++ b/Doc/howto/logging-cookbook.rst @@ -63,6 +63,7 @@ Here is the auxiliary module:: def __init__(self): self.logger = logging.getLogger('spam_application.auxiliary.Auxiliary') self.logger.info('creating an instance of Auxiliary') + def do_something(self): self.logger.info('doing something') a = 1 + 1 @@ -360,7 +361,7 @@ classes, which would eat up one thread per handler for no particular benefit. An example of using these two classes follows (imports omitted):: - que = queue.Queue(-1) # no limit on size + que = queue.Queue(-1) # no limit on size queue_handler = QueueHandler(que) handler = logging.StreamHandler() listener = QueueListener(que, handler) @@ -656,21 +657,21 @@ script:: return True if __name__ == '__main__': - levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL) - logging.basicConfig(level=logging.DEBUG, - format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s') - a1 = logging.getLogger('a.b.c') - a2 = logging.getLogger('d.e.f') - - f = ContextFilter() - a1.addFilter(f) - a2.addFilter(f) - a1.debug('A debug message') - a1.info('An info message with %s', 'some parameters') - for x in range(10): - lvl = choice(levels) - lvlname = logging.getLevelName(lvl) - a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters') + levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL) + logging.basicConfig(level=logging.DEBUG, + format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s') + a1 = logging.getLogger('a.b.c') + a2 = logging.getLogger('d.e.f') + + f = ContextFilter() + a1.addFilter(f) + a2.addFilter(f) + a1.debug('A debug message') + a1.info('An info message with %s', 'some parameters') + for x in range(10): + lvl = choice(levels) + lvlname = logging.getLevelName(lvl) + a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters') which, when run, produces something like:: @@ -764,10 +765,10 @@ the basis for code meeting your own specific requirements:: while True: try: record = queue.get() - if record is None: # We send this as a sentinel to tell the listener to quit. + if record is None: # We send this as a sentinel to tell the listener to quit. break logger = logging.getLogger(record.name) - logger.handle(record) # No level or filter logic applied - just do it! + logger.handle(record) # No level or filter logic applied - just do it! except Exception: import sys, traceback print('Whoops! Problem:', file=sys.stderr) @@ -790,10 +791,11 @@ the basis for code meeting your own specific requirements:: # Note that on Windows you can't rely on fork semantics, so each process # will run the logging configuration code when it starts. def worker_configurer(queue): - h = logging.handlers.QueueHandler(queue) # Just the one handler needed + h = logging.handlers.QueueHandler(queue) # Just the one handler needed root = logging.getLogger() root.addHandler(h) - root.setLevel(logging.DEBUG) # send all messages, for demo; no other level or filter logic applied. + # send all messages, for demo; no other level or filter logic applied. + root.setLevel(logging.DEBUG) # This is the worker process top-level loop, which just logs ten events with # random intervening delays before terminating. @@ -821,7 +823,7 @@ the basis for code meeting your own specific requirements:: workers = [] for i in range(10): worker = multiprocessing.Process(target=worker_process, - args=(queue, worker_configurer)) + args=(queue, worker_configurer)) workers.append(worker) worker.start() for w in workers: @@ -1245,12 +1247,12 @@ You can use a :class:`QueueHandler` subclass to send messages to other kinds of queues, for example a ZeroMQ 'publish' socket. In the example below,the socket is created separately and passed to the handler (as its 'queue'):: - import zmq # using pyzmq, the Python binding for ZeroMQ - import json # for serializing records portably + import zmq # using pyzmq, the Python binding for ZeroMQ + import json # for serializing records portably ctx = zmq.Context() - sock = zmq.Socket(ctx, zmq.PUB) # or zmq.PUSH, or other suitable value - sock.bind('tcp://*:5556') # or wherever + sock = zmq.Socket(ctx, zmq.PUB) # or zmq.PUSH, or other suitable value + sock.bind('tcp://*:5556') # or wherever class ZeroMQSocketHandler(QueueHandler): def enqueue(self, record): @@ -1288,7 +1290,7 @@ of queues, for example a ZeroMQ 'subscribe' socket. Here's an example:: def __init__(self, uri, *handlers, **kwargs): self.ctx = kwargs.get('ctx') or zmq.Context() socket = zmq.Socket(self.ctx, zmq.SUB) - socket.setsockopt(zmq.SUBSCRIBE, '') # subscribe to everything + socket.setsockopt(zmq.SUBSCRIBE, '') # subscribe to everything socket.connect(uri) def dequeue(self): @@ -2116,7 +2118,7 @@ class, as shown in the following example:: Format an exception so that it prints on a single line. """ result = super(OneLineExceptionFormatter, self).formatException(exc_info) - return repr(result) # or format into one line however you want to + return repr(result) # or format into one line however you want to def format(self, record): s = super(OneLineExceptionFormatter, self).format(record) diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst index d66770f..51e8430 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -103,8 +103,8 @@ A simple example A very simple example is:: import logging - logging.warning('Watch out!') # will print a message to the console - logging.info('I told you so') # will not print anything + logging.warning('Watch out!') # will print a message to the console + logging.info('I told you so') # will not print anything If you type these lines into a script and run it, you'll see:: diff --git a/Doc/howto/regex.rst b/Doc/howto/regex.rst index 909420b..de3f461 100644 --- a/Doc/howto/regex.rst +++ b/Doc/howto/regex.rst @@ -1115,19 +1115,19 @@ which can be either a string or a function, and the string to be processed. Here's a simple example of using the :meth:`sub` method. It replaces colour names with the word ``colour``:: - >>> p = re.compile( '(blue|white|red)') - >>> p.sub( 'colour', 'blue socks and red shoes') + >>> p = re.compile('(blue|white|red)') + >>> p.sub('colour', 'blue socks and red shoes') 'colour socks and colour shoes' - >>> p.sub( 'colour', 'blue socks and red shoes', count=1) + >>> p.sub('colour', 'blue socks and red shoes', count=1) 'colour socks and red shoes' The :meth:`subn` method does the same work, but returns a 2-tuple containing the new string value and the number of replacements that were performed:: - >>> p = re.compile( '(blue|white|red)') - >>> p.subn( 'colour', 'blue socks and red shoes') + >>> p = re.compile('(blue|white|red)') + >>> p.subn('colour', 'blue socks and red shoes') ('colour socks and colour shoes', 2) - >>> p.subn( 'colour', 'no colours at all') + >>> p.subn('colour', 'no colours at all') ('no colours at all', 0) Empty matches are replaced only when they're not adjacent to a previous match. diff --git a/Doc/howto/unicode.rst b/Doc/howto/unicode.rst index 24051bf..50a09ba 100644 --- a/Doc/howto/unicode.rst +++ b/Doc/howto/unicode.rst @@ -687,7 +687,7 @@ with the ``surrogateescape`` error handler:: # make changes to the string 'data' with open(fname + '.new', 'w', - encoding="ascii", errors="surrogateescape") as f: + encoding="ascii", errors="surrogateescape") as f: f.write(data) The ``surrogateescape`` error handler will decode any non-ASCII bytes diff --git a/Doc/howto/urllib2.rst b/Doc/howto/urllib2.rst index b4e2157..24a4156 100644 --- a/Doc/howto/urllib2.rst +++ b/Doc/howto/urllib2.rst @@ -175,10 +175,10 @@ Explorer [#]_. :: url = 'http://www.someserver.com/cgi-bin/register.cgi' user_agent = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64)' - values = {'name' : 'Michael Foord', - 'location' : 'Northampton', - 'language' : 'Python' } - headers = { 'User-Agent' : user_agent } + values = {'name': 'Michael Foord', + 'location': 'Northampton', + 'language': 'Python' } + headers = {'User-Agent': user_agent} data = urllib.parse.urlencode(values) data = data.encode('ascii') @@ -215,7 +215,7 @@ e.g. :: >>> req = urllib.request.Request('http://www.pretend_server.org') >>> try: urllib.request.urlopen(req) ... except urllib.error.URLError as e: - ... print(e.reason) #doctest: +SKIP + ... print(e.reason) #doctest: +SKIP ... (4, 'getaddrinfo failed') @@ -372,7 +372,7 @@ Number 2 :: from urllib.request import Request, urlopen - from urllib.error import URLError + from urllib.error import URLError req = Request(someurl) try: response = urlopen(req) diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 0bb57c1..6a7f8ef 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -35,10 +35,10 @@ produces either the sum or the max:: parser = argparse.ArgumentParser(description='Process some integers.') parser.add_argument('integers', metavar='N', type=int, nargs='+', - help='an integer for the accumulator') + help='an integer for the accumulator') parser.add_argument('--sum', dest='accumulate', action='store_const', - const=sum, default=max, - help='sum the integers (default: find the max)') + const=sum, default=max, + help='sum the integers (default: find the max)') args = parser.parse_args() print(args.accumulate(args.integers)) @@ -488,7 +488,7 @@ specified characters will be treated as files, and will be replaced by the arguments they contain. For example:: >>> with open('args.txt', 'w') as fp: - ... fp.write('-f\nbar') + ... fp.write('-f\nbar') >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@') >>> parser.add_argument('-f') >>> parser.parse_args(['-f', 'foo', '@args.txt']) @@ -1109,9 +1109,9 @@ argument:: >>> parser = argparse.ArgumentParser(prog='frobble') >>> parser.add_argument('--foo', action='store_true', - ... help='foo the bars before frobbling') + ... help='foo the bars before frobbling') >>> parser.add_argument('bar', nargs='+', - ... help='one of the bars to be frobbled') + ... help='one of the bars to be frobbled') >>> parser.parse_args(['-h']) usage: frobble [-h] [--foo] bar [bar ...] @@ -1129,7 +1129,7 @@ specifiers include the program name, ``%(prog)s`` and most keyword arguments to >>> parser = argparse.ArgumentParser(prog='frobble') >>> parser.add_argument('bar', nargs='?', type=int, default=42, - ... help='the bar to %(prog)s (default: %(default)s)') + ... help='the bar to %(prog)s (default: %(default)s)') >>> parser.print_help() usage: frobble [-h] [bar] @@ -1468,10 +1468,10 @@ interactive prompt:: >>> parser = argparse.ArgumentParser() >>> parser.add_argument( ... 'integers', metavar='int', type=int, choices=range(10), - ... nargs='+', help='an integer in the range 0..9') + ... nargs='+', help='an integer in the range 0..9') >>> parser.add_argument( ... '--sum', dest='accumulate', action='store_const', const=sum, - ... default=max, help='sum the integers (default: find the max)') + ... default=max, help='sum the integers (default: find the max)') >>> parser.parse_args(['1', '2', '3', '4']) Namespace(accumulate=<built-in function max>, integers=[1, 2, 3, 4]) >>> parser.parse_args(['1', '2', '3', '4', '--sum']) diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst index 794da8c..56ad4f8 100644 --- a/Doc/library/asynchat.rst +++ b/Doc/library/asynchat.rst @@ -202,7 +202,7 @@ any extraneous data sent by the web client are ignored. :: self.set_terminator(None) self.handle_request() elif not self.handling: - self.set_terminator(None) # browsers sometimes over-send + self.set_terminator(None) # browsers sometimes over-send self.cgi_data = parse(self.headers, b"".join(self.ibuffer)) self.handling = True self.ibuffer = [] diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst index ad3b523..1d299ec6 100644 --- a/Doc/library/asyncio-sync.rst +++ b/Doc/library/asyncio-sync.rst @@ -71,14 +71,14 @@ Lock lock = Lock() ... with (yield from lock): - ... + ... Lock objects can be tested for locking state:: if not lock.locked(): - yield from lock + yield from lock else: - # lock is acquired + # lock is acquired ... .. method:: locked() diff --git a/Doc/library/asyncore.rst b/Doc/library/asyncore.rst index 917d044..02ae72a 100644 --- a/Doc/library/asyncore.rst +++ b/Doc/library/asyncore.rst @@ -315,8 +315,8 @@ implement its socket handling:: self.buffer = self.buffer[sent:] - client = HTTPClient('www.python.org', '/') - asyncore.loop() + client = HTTPClient('www.python.org', '/') + asyncore.loop() .. _asyncore-example-2: diff --git a/Doc/library/audioop.rst b/Doc/library/audioop.rst index ce127aa..e850c3f 100644 --- a/Doc/library/audioop.rst +++ b/Doc/library/audioop.rst @@ -276,6 +276,6 @@ sample and subtract the whole output sample from the input sample:: # out_test) prefill = '\0'*(pos+ipos)*2 postfill = '\0'*(len(inputdata)-len(prefill)-len(outputdata)) - outputdata = prefill + audioop.mul(outputdata,2,-factor) + postfill + outputdata = prefill + audioop.mul(outputdata, 2, -factor) + postfill return audioop.add(inputdata, outputdata, 2) diff --git a/Doc/library/collections.abc.rst b/Doc/library/collections.abc.rst index 2385587..ec10a1e 100644 --- a/Doc/library/collections.abc.rst +++ b/Doc/library/collections.abc.rst @@ -225,19 +225,22 @@ The ABC supplies the remaining methods such as :meth:`__and__` and :meth:`isdisjoint`:: class ListBasedSet(collections.abc.Set): - ''' Alternate set implementation favoring space over speed - and not requiring the set elements to be hashable. ''' - def __init__(self, iterable): - self.elements = lst = [] - for value in iterable: - if value not in lst: - lst.append(value) - def __iter__(self): - return iter(self.elements) - def __contains__(self, value): - return value in self.elements - def __len__(self): - return len(self.elements) + ''' Alternate set implementation favoring space over speed + and not requiring the set elements to be hashable. ''' + def __init__(self, iterable): + self.elements = lst = [] + for value in iterable: + if value not in lst: + lst.append(value) + + def __iter__(self): + return iter(self.elements) + + def __contains__(self, value): + return value in self.elements + + def __len__(self): + return len(self.elements) s1 = ListBasedSet('abcdef') s2 = ListBasedSet('defghi') diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst index a410ed4..b67db53 100644 --- a/Doc/library/collections.rst +++ b/Doc/library/collections.rst @@ -1032,7 +1032,7 @@ Since an ordered dictionary remembers its insertion order, it can be used in conjunction with sorting to make a sorted dictionary:: >>> # regular unsorted dictionary - >>> d = {'banana': 3, 'apple':4, 'pear': 1, 'orange': 2} + >>> d = {'banana': 3, 'apple': 4, 'pear': 1, 'orange': 2} >>> # dictionary sorted by key >>> OrderedDict(sorted(d.items(), key=lambda t: t[0])) diff --git a/Doc/library/concurrent.futures.rst b/Doc/library/concurrent.futures.rst index 5fc8b90..15858be 100644 --- a/Doc/library/concurrent.futures.rst +++ b/Doc/library/concurrent.futures.rst @@ -99,12 +99,12 @@ the results of another :class:`Future`. For example:: import time def wait_on_b(): time.sleep(5) - print(b.result()) # b will never complete because it is waiting on a. + print(b.result()) # b will never complete because it is waiting on a. return 5 def wait_on_a(): time.sleep(5) - print(a.result()) # a will never complete because it is waiting on b. + print(a.result()) # a will never complete because it is waiting on b. return 6 diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst index c9187a3..c5dc8d7 100644 --- a/Doc/library/configparser.rst +++ b/Doc/library/configparser.rst @@ -833,13 +833,13 @@ To get interpolation, use :class:`ConfigParser`:: # Set the optional *raw* argument of get() to True if you wish to disable # interpolation in a single get operation. - print(cfg.get('Section1', 'foo', raw=False)) # -> "Python is fun!" - print(cfg.get('Section1', 'foo', raw=True)) # -> "%(bar)s is %(baz)s!" + print(cfg.get('Section1', 'foo', raw=False)) # -> "Python is fun!" + print(cfg.get('Section1', 'foo', raw=True)) # -> "%(bar)s is %(baz)s!" # The optional *vars* argument is a dict with members that will take # precedence in interpolation. print(cfg.get('Section1', 'foo', vars={'bar': 'Documentation', - 'baz': 'evil'})) + 'baz': 'evil'})) # The optional *fallback* argument can be used to provide a fallback value print(cfg.get('Section1', 'foo')) @@ -866,10 +866,10 @@ interpolation if an option used is not defined elsewhere. :: config = configparser.ConfigParser({'bar': 'Life', 'baz': 'hard'}) config.read('example.cfg') - print(config.get('Section1', 'foo')) # -> "Python is fun!" + print(config.get('Section1', 'foo')) # -> "Python is fun!" config.remove_option('Section1', 'bar') config.remove_option('Section1', 'baz') - print(config.get('Section1', 'foo')) # -> "Life is hard!" + print(config.get('Section1', 'foo')) # -> "Life is hard!" .. _configparser-objects: diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst index 7876e7a..11de8b1 100644 --- a/Doc/library/contextlib.rst +++ b/Doc/library/contextlib.rst @@ -656,7 +656,7 @@ to yield if an attempt is made to use them a second time:: Before After >>> with cm: - ... pass + ... pass ... Traceback (most recent call last): ... diff --git a/Doc/library/crypt.rst b/Doc/library/crypt.rst index 04ffdb2..42ae32e 100644 --- a/Doc/library/crypt.rst +++ b/Doc/library/crypt.rst @@ -149,4 +149,4 @@ check it against the original:: hashed = crypt.crypt(plaintext) if not compare_hash(hashed, crypt.crypt(plaintext, hashed)): - raise ValueError("hashed version doesn't validate against original") + raise ValueError("hashed version doesn't validate against original") diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst index e2a18c1..4da276c 100644 --- a/Doc/library/ctypes.rst +++ b/Doc/library/ctypes.rst @@ -52,11 +52,11 @@ library containing most standard C functions, and uses the cdecl calling convention:: >>> from ctypes import * - >>> print(windll.kernel32) # doctest: +WINDOWS + >>> print(windll.kernel32) # doctest: +WINDOWS <WinDLL 'kernel32', handle ... at ...> - >>> print(cdll.msvcrt) # doctest: +WINDOWS + >>> print(cdll.msvcrt) # doctest: +WINDOWS <CDLL 'msvcrt', handle ... at ...> - >>> libc = cdll.msvcrt # doctest: +WINDOWS + >>> libc = cdll.msvcrt # doctest: +WINDOWS >>> Windows appends the usual ``.dll`` file suffix automatically. @@ -72,10 +72,10 @@ load a library, so attribute access can not be used to load libraries. Either th :meth:`LoadLibrary` method of the dll loaders should be used, or you should load the library by creating an instance of CDLL by calling the constructor:: - >>> cdll.LoadLibrary("libc.so.6") # doctest: +LINUX + >>> cdll.LoadLibrary("libc.so.6") # doctest: +LINUX <CDLL 'libc.so.6', handle ... at ...> - >>> libc = CDLL("libc.so.6") # doctest: +LINUX - >>> libc # doctest: +LINUX + >>> libc = CDLL("libc.so.6") # doctest: +LINUX + >>> libc # doctest: +LINUX <CDLL 'libc.so.6', handle ... at ...> >>> @@ -92,9 +92,9 @@ Functions are accessed as attributes of dll objects:: >>> from ctypes import * >>> libc.printf <_FuncPtr object at 0x...> - >>> print(windll.kernel32.GetModuleHandleA) # doctest: +WINDOWS + >>> print(windll.kernel32.GetModuleHandleA) # doctest: +WINDOWS <_FuncPtr object at 0x...> - >>> print(windll.kernel32.MyOwnFunction) # doctest: +WINDOWS + >>> print(windll.kernel32.MyOwnFunction) # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? File "ctypes.py", line 239, in __getattr__ @@ -123,16 +123,16 @@ Sometimes, dlls export functions with names which aren't valid Python identifiers, like ``"??2@YAPAXI@Z"``. In this case you have to use :func:`getattr` to retrieve the function:: - >>> getattr(cdll.msvcrt, "??2@YAPAXI@Z") # doctest: +WINDOWS + >>> getattr(cdll.msvcrt, "??2@YAPAXI@Z") # doctest: +WINDOWS <_FuncPtr object at 0x...> >>> On Windows, some dlls export functions not by name but by ordinal. These functions can be accessed by indexing the dll object with the ordinal number:: - >>> cdll.kernel32[1] # doctest: +WINDOWS + >>> cdll.kernel32[1] # doctest: +WINDOWS <_FuncPtr object at 0x...> - >>> cdll.kernel32[0] # doctest: +WINDOWS + >>> cdll.kernel32[0] # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? File "ctypes.py", line 310, in __getitem__ @@ -154,9 +154,9 @@ handle. This example calls both functions with a NULL pointer (``None`` should be used as the NULL pointer):: - >>> print(libc.time(None)) # doctest: +SKIP + >>> print(libc.time(None)) # doctest: +SKIP 1150640792 - >>> print(hex(windll.kernel32.GetModuleHandleA(None))) # doctest: +WINDOWS + >>> print(hex(windll.kernel32.GetModuleHandleA(None))) # doctest: +WINDOWS 0x1d000000 >>> @@ -165,11 +165,11 @@ of arguments or the wrong calling convention. Unfortunately this only works on Windows. It does this by examining the stack after the function returns, so although an error is raised the function *has* been called:: - >>> windll.kernel32.GetModuleHandleA() # doctest: +WINDOWS + >>> windll.kernel32.GetModuleHandleA() # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? ValueError: Procedure probably called with not enough arguments (4 bytes missing) - >>> windll.kernel32.GetModuleHandleA(0, 0) # doctest: +WINDOWS + >>> windll.kernel32.GetModuleHandleA(0, 0) # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? ValueError: Procedure probably called with too many arguments (4 bytes in excess) @@ -178,13 +178,13 @@ although an error is raised the function *has* been called:: The same exception is raised when you call an ``stdcall`` function with the ``cdecl`` calling convention, or vice versa:: - >>> cdll.kernel32.GetModuleHandleA(None) # doctest: +WINDOWS + >>> cdll.kernel32.GetModuleHandleA(None) # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? ValueError: Procedure probably called with not enough arguments (4 bytes missing) >>> - >>> windll.msvcrt.printf(b"spam") # doctest: +WINDOWS + >>> windll.msvcrt.printf(b"spam") # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? ValueError: Procedure probably called with too many arguments (4 bytes in excess) @@ -197,7 +197,7 @@ On Windows, :mod:`ctypes` uses win32 structured exception handling to prevent crashes from general protection faults when functions are called with invalid argument values:: - >>> windll.kernel32.GetModuleHandleA(32) # doctest: +WINDOWS + >>> windll.kernel32.GetModuleHandleA(32) # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? OSError: exception: access violation reading 0x00000020 @@ -462,9 +462,9 @@ Here is a more advanced example, it uses the ``strchr`` function, which expects a string pointer and a char, and returns a pointer to a string:: >>> strchr = libc.strchr - >>> strchr(b"abcdef", ord("d")) # doctest: +SKIP + >>> strchr(b"abcdef", ord("d")) # doctest: +SKIP 8059983 - >>> strchr.restype = c_char_p # c_char_p is a pointer to a string + >>> strchr.restype = c_char_p # c_char_p is a pointer to a string >>> strchr(b"abcdef", ord("d")) b'def' >>> print(strchr(b"abcdef", ord("x"))) @@ -495,17 +495,17 @@ callable will be called with the *integer* the C function returns, and the result of this call will be used as the result of your function call. This is useful to check for error return values and automatically raise an exception:: - >>> GetModuleHandle = windll.kernel32.GetModuleHandleA # doctest: +WINDOWS + >>> GetModuleHandle = windll.kernel32.GetModuleHandleA # doctest: +WINDOWS >>> def ValidHandle(value): ... if value == 0: ... raise WinError() ... return value ... >>> - >>> GetModuleHandle.restype = ValidHandle # doctest: +WINDOWS - >>> GetModuleHandle(None) # doctest: +WINDOWS + >>> GetModuleHandle.restype = ValidHandle # doctest: +WINDOWS + >>> GetModuleHandle(None) # doctest: +WINDOWS 486539264 - >>> GetModuleHandle("something silly") # doctest: +WINDOWS + >>> GetModuleHandle("something silly") # doctest: +WINDOWS Traceback (most recent call last): File "<stdin>", line 1, in ? File "<stdin>", line 3, in ValidHandle @@ -676,12 +676,12 @@ POINTs among other stuff:: >>> from ctypes import * >>> class POINT(Structure): - ... _fields_ = ("x", c_int), ("y", c_int) + ... _fields_ = ("x", c_int), ("y", c_int) ... >>> class MyStruct(Structure): - ... _fields_ = [("a", c_int), - ... ("b", c_float), - ... ("point_array", POINT * 4)] + ... _fields_ = [("a", c_int), + ... ("b", c_float), + ... ("point_array", POINT * 4)] >>> >>> print(len(MyStruct().point_array)) 4 @@ -998,7 +998,7 @@ passed:: The result:: - >>> qsort(ia, len(ia), sizeof(c_int), cmp_func) # doctest: +LINUX + >>> qsort(ia, len(ia), sizeof(c_int), cmp_func) # doctest: +LINUX py_cmp_func 5 1 py_cmp_func 33 99 py_cmp_func 7 33 @@ -1100,9 +1100,9 @@ access violation or whatever, so it's better to break out of the loop when we hit the NULL entry:: >>> for item in table: - ... print(item.name, item.size) - ... if item.name is None: - ... break + ... print(item.name, item.size) + ... if item.name is None: + ... break ... __hello__ 104 __phello__ -104 diff --git a/Doc/library/email.headerregistry.rst b/Doc/library/email.headerregistry.rst index db3aade..4af083f 100644 --- a/Doc/library/email.headerregistry.rst +++ b/Doc/library/email.headerregistry.rst @@ -171,7 +171,7 @@ headers. :class:`~datetime.datetime` instance. This means, for example, that the following code is valid and does what one would expect:: - msg['Date'] = datetime(2011, 7, 15, 21) + msg['Date'] = datetime(2011, 7, 15, 21) Because this is a naive ``datetime`` it will be interpreted as a UTC timestamp, and the resulting value will have a timezone of ``-0000``. Much diff --git a/Doc/library/getopt.rst b/Doc/library/getopt.rst index f9a1e53..832d458 100644 --- a/Doc/library/getopt.rst +++ b/Doc/library/getopt.rst @@ -124,7 +124,7 @@ In a script, typical usage is something like this:: opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="]) except getopt.GetoptError as err: # print help information and exit: - print(err) # will print something like "option -a not recognized" + print(err) # will print something like "option -a not recognized" usage() sys.exit(2) output = None diff --git a/Doc/library/html.parser.rst b/Doc/library/html.parser.rst index a084d3d..2f93c0b 100644 --- a/Doc/library/html.parser.rst +++ b/Doc/library/html.parser.rst @@ -51,8 +51,10 @@ as they are encountered:: class MyHTMLParser(HTMLParser): def handle_starttag(self, tag, attrs): print("Encountered a start tag:", tag) + def handle_endtag(self, tag): print("Encountered an end tag :", tag) + def handle_data(self, data): print("Encountered some data :", data) @@ -237,21 +239,27 @@ examples:: print("Start tag:", tag) for attr in attrs: print(" attr:", attr) + def handle_endtag(self, tag): print("End tag :", tag) + def handle_data(self, data): print("Data :", data) + def handle_comment(self, data): print("Comment :", data) + def handle_entityref(self, name): c = chr(name2codepoint[name]) print("Named ent:", c) + def handle_charref(self, name): if name.startswith('x'): c = chr(int(name[1:], 16)) else: c = chr(int(name)) print("Num ent :", c) + def handle_decl(self, data): print("Decl :", data) @@ -283,7 +291,7 @@ further parsing:: attr: ('type', 'text/css') Data : #python { color: green } End tag : style - >>> + >>> parser.feed('<script type="text/javascript">' ... 'alert("<strong>hello!</strong>");</script>') Start tag: script diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst index 649abd1..bd91845 100644 --- a/Doc/library/http.client.rst +++ b/Doc/library/http.client.rst @@ -441,7 +441,7 @@ Here is an example session that uses the ``GET`` method:: >>> conn.request("GET", "/") >>> r1 = conn.getresponse() >>> while not r1.closed: - ... print(r1.read(200)) # 200 bytes + ... print(r1.read(200)) # 200 bytes b'<!doctype html>\n<!--[if"... ... >>> # Example of an invalid request diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index aa8a181..11766b7 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -768,7 +768,7 @@ function. functions:: def test(a, *, b): - ... + ... sig = signature(test) ba = sig.bind(10, b=20) diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst index e2fc742..6a7b979 100644 --- a/Doc/library/ipaddress.rst +++ b/Doc/library/ipaddress.rst @@ -653,7 +653,7 @@ network. For iteration, *all* hosts are returned, including unusable hosts example:: >>> for addr in IPv4Network('192.0.2.0/28'): - ... addr + ... addr ... IPv4Address('192.0.2.0') IPv4Address('192.0.2.1') diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index 61b79fa..dd17d4f 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -467,13 +467,13 @@ The :mod:`locale` module defines the following exception and functions: Example:: >>> import locale - >>> loc = locale.getlocale() # get current locale + >>> loc = locale.getlocale() # get current locale # use German locale; name might vary with platform >>> locale.setlocale(locale.LC_ALL, 'de_DE') - >>> locale.strcoll('f\xe4n', 'foo') # compare a string containing an umlaut - >>> locale.setlocale(locale.LC_ALL, '') # use user's preferred locale - >>> locale.setlocale(locale.LC_ALL, 'C') # use default (C) locale - >>> locale.setlocale(locale.LC_ALL, loc) # restore saved locale + >>> locale.strcoll('f\xe4n', 'foo') # compare a string containing an umlaut + >>> locale.setlocale(locale.LC_ALL, '') # use user's preferred locale + >>> locale.setlocale(locale.LC_ALL, 'C') # use default (C) locale + >>> locale.setlocale(locale.LC_ALL, loc) # restore saved locale Background, details, hints, tips and caveats diff --git a/Doc/library/mailcap.rst b/Doc/library/mailcap.rst index 8115e42..896afd1 100644 --- a/Doc/library/mailcap.rst +++ b/Doc/library/mailcap.rst @@ -70,7 +70,7 @@ standard. However, mailcap files are supported on most Unix systems. An example usage:: >>> import mailcap - >>> d=mailcap.getcaps() + >>> d = mailcap.getcaps() >>> mailcap.findmatch(d, 'video/mpeg', filename='tmp1223') ('xmpeg tmp1223', {'view': 'xmpeg %s'}) diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst index d97ae9d..f26a4d4 100644 --- a/Doc/library/mmap.rst +++ b/Doc/library/mmap.rst @@ -144,7 +144,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length pid = os.fork() - if pid == 0: # In a child process + if pid == 0: # In a child process mm.seek(0) print(mm.readline()) diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 6440f5c..1b1d386 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -2668,8 +2668,8 @@ Explicitly pass resources to child processes ... do something using "lock" ... if __name__ == '__main__': - lock = Lock() - for i in range(10): + lock = Lock() + for i in range(10): Process(target=f).start() should be rewritten as :: @@ -2680,8 +2680,8 @@ Explicitly pass resources to child processes ... do something using "l" ... if __name__ == '__main__': - lock = Lock() - for i in range(10): + lock = Lock() + for i in range(10): Process(target=f, args=(lock,)).start() Beware of replacing :data:`sys.stdin` with a "file like object" diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst index 160c29d..c5db3ea 100644 --- a/Doc/library/optparse.rst +++ b/Doc/library/optparse.rst @@ -25,7 +25,7 @@ GNU/POSIX syntax, and additionally generates usage and help messages for you. Here's an example of using :mod:`optparse` in a simple script:: from optparse import OptionParser - [...] + ... parser = OptionParser() parser.add_option("-f", "--file", dest="filename", help="write report to FILE", metavar="FILE") @@ -252,7 +252,7 @@ First, you need to import the OptionParser class; then, early in the main program, create an OptionParser instance:: from optparse import OptionParser - [...] + ... parser = OptionParser() Then you can start defining options. The basic syntax is:: @@ -718,7 +718,7 @@ you can call :func:`OptionParser.error` to signal an application-defined error condition:: (options, args) = parser.parse_args() - [...] + ... if options.a and options.b: parser.error("options -a and -b are mutually exclusive") @@ -758,7 +758,7 @@ Putting it all together Here's what :mod:`optparse`\ -based scripts usually look like:: from optparse import OptionParser - [...] + ... def main(): usage = "usage: %prog [options] arg" parser = OptionParser(usage) @@ -768,13 +768,13 @@ Here's what :mod:`optparse`\ -based scripts usually look like:: action="store_true", dest="verbose") parser.add_option("-q", "--quiet", action="store_false", dest="verbose") - [...] + ... (options, args) = parser.parse_args() if len(args) != 1: parser.error("incorrect number of arguments") if options.verbose: print("reading %s..." % options.filename) - [...] + ... if __name__ == "__main__": main() @@ -1409,7 +1409,7 @@ If you're not careful, it's easy to define options with conflicting option strings:: parser.add_option("-n", "--dry-run", ...) - [...] + ... parser.add_option("-n", "--noisy", ...) (This is particularly true if you've defined your own OptionParser subclass with @@ -1450,7 +1450,7 @@ that option. If the user asks for help, the help message will reflect that:: Options: --dry-run do no harm - [...] + ... -n, --noisy be noisy It's possible to whittle away the option strings for a previously-added option @@ -1465,7 +1465,7 @@ At this point, the original ``-n``/``--dry-run`` option is no longer accessible, so :mod:`optparse` removes it, leaving this help text:: Options: - [...] + ... -n, --noisy be noisy --dry-run new dry-run option @@ -1701,7 +1701,7 @@ seen, but blow up if it comes after ``-b`` in the command-line. :: if parser.values.b: raise OptionValueError("can't use -a after -b") parser.values.a = 1 - [...] + ... parser.add_option("-a", action="callback", callback=check_order) parser.add_option("-b", action="store_true", dest="b") @@ -1719,7 +1719,7 @@ message and the flag that it sets must be generalized. :: if parser.values.b: raise OptionValueError("can't use %s after -b" % opt_str) setattr(parser.values, option.dest, 1) - [...] + ... parser.add_option("-a", action="callback", callback=check_order, dest='a') parser.add_option("-b", action="store_true", dest="b") parser.add_option("-c", action="callback", callback=check_order, dest='c') @@ -1739,7 +1739,7 @@ should not be called when the moon is full, all you have to do is this:: raise OptionValueError("%s option invalid when moon is full" % opt_str) setattr(parser.values, option.dest, 1) - [...] + ... parser.add_option("--foo", action="callback", callback=check_moon, dest="foo") @@ -1762,7 +1762,7 @@ Here's an example that just emulates the standard ``"store"`` action:: def store_value(option, opt_str, value, parser): setattr(parser.values, option.dest, value) - [...] + ... parser.add_option("--foo", action="callback", callback=store_value, type="int", nargs=3, dest="foo") @@ -1824,9 +1824,9 @@ arguments:: del parser.rargs[:len(value)] setattr(parser.values, option.dest, value) - [...] - parser.add_option("-c", "--callback", dest="vararg_attr", - action="callback", callback=vararg_callback) + ... + parser.add_option("-c", "--callback", dest="vararg_attr", + action="callback", callback=vararg_callback) .. _optparse-extending-optparse: diff --git a/Doc/library/re.rst b/Doc/library/re.rst index fdd5083..82beba1 100644 --- a/Doc/library/re.rst +++ b/Doc/library/re.rst @@ -1234,15 +1234,15 @@ does by default). For example:: - >>> re.match("c", "abcdef") # No match - >>> re.search("c", "abcdef") # Match + >>> re.match("c", "abcdef") # No match + >>> re.search("c", "abcdef") # Match <_sre.SRE_Match object; span=(2, 3), match='c'> Regular expressions beginning with ``'^'`` can be used with :func:`search` to restrict the match at the beginning of the string:: - >>> re.match("c", "abcdef") # No match - >>> re.search("^c", "abcdef") # No match + >>> re.match("c", "abcdef") # No match + >>> re.search("^c", "abcdef") # No match >>> re.search("^a", "abcdef") # Match <_sre.SRE_Match object; span=(0, 1), match='a'> @@ -1323,9 +1323,9 @@ a function to "munge" text, or randomize the order of all the characters in each word of a sentence except for the first and last characters:: >>> def repl(m): - ... inner_word = list(m.group(2)) - ... random.shuffle(inner_word) - ... return m.group(1) + "".join(inner_word) + m.group(3) + ... inner_word = list(m.group(2)) + ... random.shuffle(inner_word) + ... return m.group(1) + "".join(inner_word) + m.group(3) >>> text = "Professor Abdolmalek, please report your absences promptly." >>> re.sub(r"(\w)(\w+)(\w)", repl, text) 'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.' @@ -1405,14 +1405,14 @@ successive matches:: def tokenize(code): keywords = {'IF', 'THEN', 'ENDIF', 'FOR', 'NEXT', 'GOSUB', 'RETURN'} token_specification = [ - ('NUMBER', r'\d+(\.\d*)?'), # Integer or decimal number - ('ASSIGN', r':='), # Assignment operator - ('END', r';'), # Statement terminator - ('ID', r'[A-Za-z]+'), # Identifiers - ('OP', r'[+\-*/]'), # Arithmetic operators - ('NEWLINE', r'\n'), # Line endings - ('SKIP', r'[ \t]+'), # Skip over spaces and tabs - ('MISMATCH',r'.'), # Any other character + ('NUMBER', r'\d+(\.\d*)?'), # Integer or decimal number + ('ASSIGN', r':='), # Assignment operator + ('END', r';'), # Statement terminator + ('ID', r'[A-Za-z]+'), # Identifiers + ('OP', r'[+\-*/]'), # Arithmetic operators + ('NEWLINE', r'\n'), # Line endings + ('SKIP', r'[ \t]+'), # Skip over spaces and tabs + ('MISMATCH',r'.'), # Any other character ] tok_regex = '|'.join('(?P<%s>%s)' % pair for pair in token_specification) line_num = 1 diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst index 204967a..f89368b 100644 --- a/Doc/library/shelve.rst +++ b/Doc/library/shelve.rst @@ -165,32 +165,33 @@ object):: import shelve - d = shelve.open(filename) # open -- file may get suffix added by low-level - # library - - d[key] = data # store data at key (overwrites old data if - # using an existing key) - data = d[key] # retrieve a COPY of data at key (raise KeyError if no - # such key) - del d[key] # delete data stored at key (raises KeyError - # if no such key) - flag = key in d # true if the key exists - klist = list(d.keys()) # a list of all existing keys (slow!) + d = shelve.open(filename) # open -- file may get suffix added by low-level + # library + + d[key] = data # store data at key (overwrites old data if + # using an existing key) + data = d[key] # retrieve a COPY of data at key (raise KeyError + # if no such key) + del d[key] # delete data stored at key (raises KeyError + # if no such key) + + flag = key in d # true if the key exists + klist = list(d.keys()) # a list of all existing keys (slow!) # as d was opened WITHOUT writeback=True, beware: - d['xx'] = [0, 1, 2] # this works as expected, but... - d['xx'].append(3) # *this doesn't!* -- d['xx'] is STILL [0, 1, 2]! + d['xx'] = [0, 1, 2] # this works as expected, but... + d['xx'].append(3) # *this doesn't!* -- d['xx'] is STILL [0, 1, 2]! # having opened d without writeback=True, you need to code carefully: - temp = d['xx'] # extracts the copy - temp.append(5) # mutates the copy - d['xx'] = temp # stores the copy right back, to persist it + temp = d['xx'] # extracts the copy + temp.append(5) # mutates the copy + d['xx'] = temp # stores the copy right back, to persist it # or, d=shelve.open(filename,writeback=True) would let you just code # d['xx'].append(5) and have it work as expected, BUT it would also # consume more memory and make the d.close() operation slower. - d.close() # close it + d.close() # close it .. seealso:: diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 0367569..d458d8b 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -1585,7 +1585,7 @@ should use the following idiom:: except ImportError: pass else: - ... # do something that requires SSL support + ... # do something that requires SSL support Client-side operation ^^^^^^^^^^^^^^^^^^^^^ diff --git a/Doc/library/string.rst b/Doc/library/string.rst index 4eb2db4..c421c72 100644 --- a/Doc/library/string.rst +++ b/Doc/library/string.rst @@ -236,12 +236,12 @@ does an index lookup using :func:`__getitem__`. Some simple format string examples:: - "First, thou shalt count to {0}" # References first positional argument - "Bring me a {}" # Implicitly references the first positional argument - "From {} to {}" # Same as "From {0} to {1}" - "My quest is {name}" # References keyword argument 'name' - "Weight in tons {0.weight}" # 'weight' attribute of first positional arg - "Units destroyed: {players[0]}" # First element of keyword argument 'players'. + "First, thou shalt count to {0}" # References first positional argument + "Bring me a {}" # Implicitly references the first positional argument + "From {} to {}" # Same as "From {0} to {1}" + "My quest is {name}" # References keyword argument 'name' + "Weight in tons {0.weight}" # 'weight' attribute of first positional arg + "Units destroyed: {players[0]}" # First element of keyword argument 'players'. The *conversion* field causes a type coercion before formatting. Normally, the job of formatting a value is done by the :meth:`__format__` method of the value diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index c56d707..3066496 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -847,7 +847,7 @@ For example:: print("hello, world") t = Timer(30.0, hello) - t.start() # after 30 seconds, "hello, world" will be printed + t.start() # after 30 seconds, "hello, world" will be printed .. class:: Timer(interval, function, args=None, kwargs=None) diff --git a/Doc/library/tkinter.rst b/Doc/library/tkinter.rst index 7b14d55..5393124 100644 --- a/Doc/library/tkinter.rst +++ b/Doc/library/tkinter.rst @@ -206,7 +206,7 @@ A Simple Hello World Program self.hi_there.pack(side="top") self.QUIT = tk.Button(self, text="QUIT", fg="red", - command=root.destroy) + command=root.destroy) self.QUIT.pack(side="bottom") def say_hi(self): diff --git a/Doc/library/tokenize.rst b/Doc/library/tokenize.rst index a5f3be3..272e370 100644 --- a/Doc/library/tokenize.rst +++ b/Doc/library/tokenize.rst @@ -201,7 +201,7 @@ objects:: we're only showing 12 digits, and the 13th isn't close to 5, the rest of the output should be platform-independent. - >>> exec(s) #doctest: +ELLIPSIS + >>> exec(s) #doctest: +ELLIPSIS -3.21716034272e-0...7 Output from calculations with Decimal should be identical across all @@ -211,8 +211,8 @@ objects:: -3.217160342717258261933904529E-7 """ result = [] - g = tokenize(BytesIO(s.encode('utf-8')).readline) # tokenize the string - for toknum, tokval, _, _, _ in g: + g = tokenize(BytesIO(s.encode('utf-8')).readline) # tokenize the string + for toknum, tokval, _, _, _ in g: if toknum == NUMBER and '.' in tokval: # replace NUMBER tokens result.extend([ (NAME, 'Decimal'), diff --git a/Doc/library/types.rst b/Doc/library/types.rst index eb27846..118bc4c 100644 --- a/Doc/library/types.rst +++ b/Doc/library/types.rst @@ -252,10 +252,12 @@ Additional Utility Classes and Functions class SimpleNamespace: def __init__(self, **kwargs): self.__dict__.update(kwargs) + def __repr__(self): keys = sorted(self.__dict__) items = ("{}={!r}".format(k, self.__dict__[k]) for k in keys) return "{}({})".format(type(self).__name__, ", ".join(items)) + def __eq__(self, other): return self.__dict__ == other.__dict__ diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index 2e260d1..8482f20 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -86,19 +86,19 @@ Here is a short script to test three string methods:: class TestStringMethods(unittest.TestCase): - def test_upper(self): - self.assertEqual('foo'.upper(), 'FOO') - - def test_isupper(self): - self.assertTrue('FOO'.isupper()) - self.assertFalse('Foo'.isupper()) - - def test_split(self): - s = 'hello world' - self.assertEqual(s.split(), ['hello', 'world']) - # check that s.split fails when the separator is not a string - with self.assertRaises(TypeError): - s.split(2) + def test_upper(self): + self.assertEqual('foo'.upper(), 'FOO') + + def test_isupper(self): + self.assertTrue('FOO'.isupper()) + self.assertFalse('Foo'.isupper()) + + def test_split(self): + s = 'hello world' + self.assertEqual(s.split(), ['hello', 'world']) + # check that s.split fails when the separator is not a string + with self.assertRaises(TypeError): + s.split(2) if __name__ == '__main__': unittest.main() diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index 39a42e4..c9225cf 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -1174,7 +1174,7 @@ The code for the sample CGI used in the above example is:: Here is an example of doing a ``PUT`` request using :class:`Request`:: import urllib.request - DATA=b'some data' + DATA = b'some data' req = urllib.request.Request(url='http://localhost:8080', data=DATA,method='PUT') with urllib.request.urlopen(req) as f: pass diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index 8d62885..57fef44 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -419,8 +419,8 @@ Paste" library. # Our callable object which is intentionally not compliant to the # standard, so the validator is going to break def simple_app(environ, start_response): - status = '200 OK' # HTTP Status - headers = [('Content-type', 'text/plain')] # HTTP Headers + status = '200 OK' # HTTP Status + headers = [('Content-type', 'text/plain')] # HTTP Headers start_response(status, headers) # This is going to break because we need to return a list, and @@ -762,8 +762,8 @@ This is a working "Hello World" WSGI application:: # is a dictionary containing CGI-style environment variables and the # second variable is the callable object (see PEP 333). def hello_world_app(environ, start_response): - status = '200 OK' # HTTP Status - headers = [('Content-type', 'text/plain; charset=utf-8')] # HTTP Headers + status = '200 OK' # HTTP Status + headers = [('Content-type', 'text/plain; charset=utf-8')] # HTTP Headers start_response(status, headers) # The returned object is going to be printed diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst index cb1c727..a8c1f1d 100644 --- a/Doc/library/xml.dom.minidom.rst +++ b/Doc/library/xml.dom.minidom.rst @@ -30,10 +30,10 @@ DOM applications typically start by parsing some XML into a DOM. With from xml.dom.minidom import parse, parseString - dom1 = parse('c:\\temp\\mydata.xml') # parse an XML file by name + dom1 = parse('c:\\temp\\mydata.xml') # parse an XML file by name datasource = open('c:\\temp\\mydata.xml') - dom2 = parse(datasource) # parse an open file + dom2 = parse(datasource) # parse an open file dom3 = parseString('<myxml>Some data<empty/> some more data</myxml>') diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 488cf4e..f5cdf03 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -94,7 +94,7 @@ As an :class:`Element`, ``root`` has a tag and a dictionary of attributes:: It also has children nodes over which we can iterate:: >>> for child in root: - ... print(child.tag, child.attrib) + ... print(child.tag, child.attrib) ... country {'name': 'Liechtenstein'} country {'name': 'Singapore'} @@ -143,8 +143,8 @@ elements, call :meth:`XMLPullParser.read_events`. Here is an example:: [('start', <Element 'mytag' at 0x7fa66db2be58>)] >>> parser.feed(' more text</mytag>') >>> for event, elem in parser.read_events(): - ... print(event) - ... print(elem.tag, 'text=', elem.text) + ... print(event) + ... print(elem.tag, 'text=', elem.text) ... end @@ -166,7 +166,7 @@ the sub-tree below it (its children, their children, and so on). For example, :meth:`Element.iter`:: >>> for neighbor in root.iter('neighbor'): - ... print(neighbor.attrib) + ... print(neighbor.attrib) ... {'name': 'Austria', 'direction': 'E'} {'name': 'Switzerland', 'direction': 'W'} @@ -180,9 +180,9 @@ with a particular tag, and :attr:`Element.text` accesses the element's text content. :meth:`Element.get` accesses the element's attributes:: >>> for country in root.findall('country'): - ... rank = country.find('rank').text - ... name = country.get('name') - ... print(name, rank) + ... rank = country.find('rank').text + ... name = country.get('name') + ... print(name, rank) ... Liechtenstein 1 Singapore 4 @@ -206,9 +206,9 @@ Let's say we want to add one to each country's rank, and add an ``updated`` attribute to the rank element:: >>> for rank in root.iter('rank'): - ... new_rank = int(rank.text) + 1 - ... rank.text = str(new_rank) - ... rank.set('updated', 'yes') + ... new_rank = int(rank.text) + 1 + ... rank.text = str(new_rank) + ... rank.set('updated', 'yes') ... >>> tree.write('output.xml') @@ -244,9 +244,9 @@ We can remove elements using :meth:`Element.remove`. Let's say we want to remove all countries with a rank higher than 50:: >>> for country in root.findall('country'): - ... rank = int(country.find('rank').text) - ... if rank > 50: - ... root.remove(country) + ... rank = int(country.find('rank').text) + ... if rank > 50: + ... root.remove(country) ... >>> tree.write('output.xml') diff --git a/Doc/library/xmlrpc.client.rst b/Doc/library/xmlrpc.client.rst index 0edf010..f66a230 100644 --- a/Doc/library/xmlrpc.client.rst +++ b/Doc/library/xmlrpc.client.rst @@ -216,7 +216,7 @@ A working example follows. The server code:: from xmlrpc.server import SimpleXMLRPCServer def is_even(n): - return n%2 == 0 + return n % 2 == 0 server = SimpleXMLRPCServer(("localhost", 8000)) print("Listening on port 8000...") @@ -373,7 +373,7 @@ returning a complex type object. The server code:: # A marshalling error is going to occur because we're returning a # complex number - def add(x,y): + def add(x, y): return x+y+0j server = SimpleXMLRPCServer(("localhost", 8000)) @@ -566,12 +566,15 @@ transport. The following example shows how: class ProxiedTransport(xmlrpc.client.Transport): def set_proxy(self, proxy): self.proxy = proxy + def make_connection(self, host): self.realhost = host h = http.client.HTTPConnection(self.proxy) return h + def send_request(self, connection, handler, request_body, debug): connection.putrequest("POST", 'http://%s%s' % (self.realhost, handler)) + def send_host(self, connection, host): connection.putheader('Host', self.realhost) diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst index b67ccbb..c0b4930 100644 --- a/Doc/reference/datamodel.rst +++ b/Doc/reference/datamodel.rst @@ -1754,11 +1754,11 @@ to remember the order that class variables are defined:: class OrderedClass(type): - @classmethod - def __prepare__(metacls, name, bases, **kwds): + @classmethod + def __prepare__(metacls, name, bases, **kwds): return collections.OrderedDict() - def __new__(cls, name, bases, namespace, **kwds): + def __new__(cls, name, bases, namespace, **kwds): result = type.__new__(cls, name, bases, dict(namespace)) result.members = tuple(namespace) return result diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst index c3c3e06..036f4f1 100644 --- a/Doc/reference/expressions.rst +++ b/Doc/reference/expressions.rst @@ -728,7 +728,7 @@ A consequence of this is that although the ``*expression`` syntax may appear (and the ``**expression`` argument, if any -- see below). So:: >>> def f(a, b): - ... print(a, b) + ... print(a, b) ... >>> f(b=1, *(2,)) 2 1 diff --git a/Doc/reference/simple_stmts.rst b/Doc/reference/simple_stmts.rst index 79a46e2..4444add 100644 --- a/Doc/reference/simple_stmts.rst +++ b/Doc/reference/simple_stmts.rst @@ -331,12 +331,12 @@ program: The simple form, ``assert expression``, is equivalent to :: if __debug__: - if not expression: raise AssertionError + if not expression: raise AssertionError The extended form, ``assert expression1, expression2``, is equivalent to :: if __debug__: - if not expression1: raise AssertionError(expression2) + if not expression1: raise AssertionError(expression2) .. index:: single: __debug__ diff --git a/Doc/tutorial/appendix.rst b/Doc/tutorial/appendix.rst index e04459b..ffd16aa 100644 --- a/Doc/tutorial/appendix.rst +++ b/Doc/tutorial/appendix.rst @@ -92,7 +92,7 @@ in the script:: filename = os.environ.get('PYTHONSTARTUP') if filename and os.path.isfile(filename): with open(filename) as fobj: - startup_file = fobj.read() + startup_file = fobj.read() exec(startup_file) diff --git a/Doc/tutorial/classes.rst b/Doc/tutorial/classes.rst index 7e014ef..cc2c35b 100644 --- a/Doc/tutorial/classes.rst +++ b/Doc/tutorial/classes.rst @@ -162,12 +162,15 @@ binding:: def scope_test(): def do_local(): spam = "local spam" + def do_nonlocal(): nonlocal spam spam = "nonlocal spam" + def do_global(): global spam spam = "global spam" + spam = "test spam" do_local() print("After local assignment:", spam) @@ -260,6 +263,7 @@ definition looked like this:: class MyClass: """A simple example class""" i = 12345 + def f(self): return 'hello world' @@ -508,8 +512,10 @@ variable in the class is also ok. For example:: class C: f = f1 + def g(self): return 'hello world' + h = g Now ``f``, ``g`` and ``h`` are all attributes of class :class:`C` that refer to @@ -523,8 +529,10 @@ argument:: class Bag: def __init__(self): self.data = [] + def add(self, x): self.data.append(x) + def addtwice(self, x): self.add(x) self.add(x) @@ -713,7 +721,7 @@ will do nicely:: class Employee: pass - john = Employee() # Create an empty employee record + john = Employee() # Create an empty employee record # Fill the fields of the record john.name = 'John Doe' @@ -839,8 +847,10 @@ defines :meth:`__next__`, then :meth:`__iter__` can just return ``self``:: def __init__(self, data): self.data = data self.index = len(data) + def __iter__(self): return self + def __next__(self): if self.index == 0: raise StopIteration diff --git a/Doc/tutorial/controlflow.rst b/Doc/tutorial/controlflow.rst index 8453796..9a13d08 100644 --- a/Doc/tutorial/controlflow.rst +++ b/Doc/tutorial/controlflow.rst @@ -315,7 +315,7 @@ You can see it if you really want to using :func:`print`:: It is simple to write a function that returns a list of the numbers of the Fibonacci series, instead of printing it:: - >>> def fib2(n): # return Fibonacci series up to n + >>> def fib2(n): # return Fibonacci series up to n ... """Return a list containing the Fibonacci series up to n.""" ... result = [] ... a, b = 0, 1 @@ -543,7 +543,7 @@ parameter are 'keyword-only' arguments, meaning that they can only be used as keywords rather than positional arguments. :: >>> def concat(*args, sep="/"): - ... return sep.join(args) + ... return sep.join(args) ... >>> concat("earth", "mars", "venus") 'earth/mars/venus' diff --git a/Doc/tutorial/errors.rst b/Doc/tutorial/errors.rst index 351ee52..4195c7e 100644 --- a/Doc/tutorial/errors.rst +++ b/Doc/tutorial/errors.rst @@ -170,15 +170,15 @@ reference ``.args``. One may also instantiate an exception first before raising it and add any attributes to it as desired. :: >>> try: - ... raise Exception('spam', 'eggs') + ... raise Exception('spam', 'eggs') ... except Exception as inst: - ... print(type(inst)) # the exception instance - ... print(inst.args) # arguments stored in .args - ... print(inst) # __str__ allows args to be printed directly, - ... # but may be overridden in exception subclasses - ... x, y = inst.args # unpack args - ... print('x =', x) - ... print('y =', y) + ... print(type(inst)) # the exception instance + ... print(inst.args) # arguments stored in .args + ... print(inst) # __str__ allows args to be printed directly, + ... # but may be overridden in exception subclasses + ... x, y = inst.args # unpack args + ... print('x =', x) + ... print('y =', y) ... <class 'Exception'> ('spam', 'eggs') diff --git a/Doc/tutorial/inputoutput.rst b/Doc/tutorial/inputoutput.rst index 686b2b1..beeaac3 100644 --- a/Doc/tutorial/inputoutput.rst +++ b/Doc/tutorial/inputoutput.rst @@ -339,11 +339,11 @@ beginning of the file as the reference point. :: >>> f = open('workfile', 'rb+') >>> f.write(b'0123456789abcdef') 16 - >>> f.seek(5) # Go to the 6th byte in the file + >>> f.seek(5) # Go to the 6th byte in the file 5 >>> f.read(1) b'5' - >>> f.seek(-3, 2) # Go to the 3rd byte before the end + >>> f.seek(-3, 2) # Go to the 3rd byte before the end 13 >>> f.read(1) b'd' diff --git a/Doc/tutorial/introduction.rst b/Doc/tutorial/introduction.rst index 87f0fa5..7e8ee3e 100644 --- a/Doc/tutorial/introduction.rst +++ b/Doc/tutorial/introduction.rst @@ -232,7 +232,7 @@ If you want to concatenate variables or a variable and a literal, use ``+``:: This feature is particularly useful when you want to break long strings:: >>> text = ('Put several strings within parentheses ' - 'to have them joined together.') + ... 'to have them joined together.') >>> text 'Put several strings within parentheses to have them joined together.' @@ -276,11 +276,11 @@ makes sure that ``s[:i] + s[i:]`` is always equal to ``s``:: Slice indices have useful defaults; an omitted first index defaults to zero, an omitted second index defaults to the size of the string being sliced. :: - >>> word[:2] # character from the beginning to position 2 (excluded) + >>> word[:2] # character from the beginning to position 2 (excluded) 'Py' - >>> word[4:] # characters from position 4 (included) to the end + >>> word[4:] # characters from position 4 (included) to the end 'on' - >>> word[-2:] # characters from the second-last (included) to the end + >>> word[-2:] # characters from the second-last (included) to the end 'on' One way to remember how slices work is to think of the indices as pointing diff --git a/Doc/tutorial/modules.rst b/Doc/tutorial/modules.rst index 5fbd879..261a3f3 100644 --- a/Doc/tutorial/modules.rst +++ b/Doc/tutorial/modules.rst @@ -34,7 +34,7 @@ called :file:`fibo.py` in the current directory with the following contents:: a, b = b, a+b print() - def fib2(n): # return Fibonacci series up to n + def fib2(n): # return Fibonacci series up to n result = [] a, b = 0, 1 while b < n: diff --git a/Doc/tutorial/stdlib.rst b/Doc/tutorial/stdlib.rst index 7288873..1dd06c2 100644 --- a/Doc/tutorial/stdlib.rst +++ b/Doc/tutorial/stdlib.rst @@ -301,7 +301,7 @@ file:: with self.assertRaises(TypeError): average(20, 30, 70) - unittest.main() # Calling from the command line invokes all tests + unittest.main() # Calling from the command line invokes all tests .. _tut-batteries-included: diff --git a/Doc/tutorial/stdlib2.rst b/Doc/tutorial/stdlib2.rst index 71194b0..bf4cf87 100644 --- a/Doc/tutorial/stdlib2.rst +++ b/Doc/tutorial/stdlib2.rst @@ -180,6 +180,7 @@ tasks in background while the main program continues to run:: threading.Thread.__init__(self) self.infile = infile self.outfile = outfile + def run(self): f = zipfile.ZipFile(self.outfile, 'w', zipfile.ZIP_DEFLATED) f.write(self.infile) diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst index aa41b29..baaf797 100644 --- a/Doc/whatsnew/3.2.rst +++ b/Doc/whatsnew/3.2.rst @@ -116,7 +116,7 @@ or more positional arguments is present, and making a required option:: Example of calling the parser on a command string:: - >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain' + >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain' >>> result = parser.parse_args(cmd.split()) >>> result.action 'deploy' @@ -212,7 +212,8 @@ loaded and called with code like this:: >>> import json, logging.config >>> with open('conf.json') as f: - conf = json.load(f) + ... conf = json.load(f) + ... >>> logging.config.dictConfig(conf) >>> logging.info("Transaction completed normally") INFO : root : Transaction completed normally @@ -460,15 +461,15 @@ Some smaller changes made to the core Python language are: 'The testing project status is green as of February 15, 2011' >>> class LowerCasedDict(dict): - def __getitem__(self, key): - return dict.__getitem__(self, key.lower()) + ... def __getitem__(self, key): + ... return dict.__getitem__(self, key.lower()) >>> lcd = LowerCasedDict(part='widgets', quantity=10) >>> 'There are {QUANTITY} {Part} in stock'.format_map(lcd) 'There are 10 widgets in stock' >>> class PlaceholderDict(dict): - def __missing__(self, key): - return '<{}>'.format(key) + ... def __missing__(self, key): + ... return '<{}>'.format(key) >>> 'Hello {name}, welcome to {location}'.format_map(PlaceholderDict()) 'Hello <name>, welcome to <location>' @@ -496,10 +497,10 @@ Some smaller changes made to the core Python language are: exceptions pass through:: >>> class A: - @property - def f(self): - return 1 // 0 - + ... @property + ... def f(self): + ... return 1 // 0 + ... >>> a = A() >>> hasattr(a, 'f') Traceback (most recent call last): @@ -537,7 +538,7 @@ Some smaller changes made to the core Python language are: def outer(x): def inner(): - return x + return x inner() del x @@ -547,12 +548,12 @@ Some smaller changes made to the core Python language are: def f(): def print_error(): - print(e) + print(e) try: - something + something except Exception as e: - print_error() - # implicit "del e" here + print_error() + # implicit "del e" here (See :issue:`4617`.) @@ -799,6 +800,7 @@ functools def __eq__(self, other): return ((self.lastname.lower(), self.firstname.lower()) == (other.lastname.lower(), other.firstname.lower())) + def __lt__(self, other): return ((self.lastname.lower(), self.firstname.lower()) < (other.lastname.lower(), other.firstname.lower())) @@ -942,7 +944,7 @@ released and a :exc:`~threading.BrokenBarrierError` exception is raised:: def get_votes(site): ballots = conduct_election(site) try: - all_polls_closed.wait(timeout = midnight - time.now()) + all_polls_closed.wait(timeout=midnight - time.now()) except BrokenBarrierError: lockbox = seal_ballots(ballots) queue.put(lockbox) @@ -1097,16 +1099,16 @@ for slice notation are well-suited to in-place editing:: >>> REC_LEN, LOC_START, LOC_LEN = 34, 7, 11 >>> def change_location(buffer, record_number, location): - start = record_number * REC_LEN + LOC_START - buffer[start: start+LOC_LEN] = location + ... start = record_number * REC_LEN + LOC_START + ... buffer[start: start+LOC_LEN] = location >>> import io >>> byte_stream = io.BytesIO( - b'G3805 storeroom Main chassis ' - b'X7899 shipping Reserve cog ' - b'L6988 receiving Primary sprocket' - ) + ... b'G3805 storeroom Main chassis ' + ... b'X7899 shipping Reserve cog ' + ... b'L6988 receiving Primary sprocket' + ... ) >>> buffer = byte_stream.getbuffer() >>> change_location(buffer, 1, b'warehouse ') >>> change_location(buffer, 0, b'showroom ') @@ -1131,10 +1133,10 @@ decorator, :func:`~reprlib.recursive_repr`, for detecting recursive calls to :meth:`__repr__` and substituting a placeholder string instead:: >>> class MyList(list): - @recursive_repr() - def __repr__(self): - return '<' + '|'.join(map(repr, self)) + '>' - + ... @recursive_repr() + ... def __repr__(self): + ... return '<' + '|'.join(map(repr, self)) + '>' + ... >>> m = MyList('abc') >>> m.append(m) >>> m.append('x') @@ -1197,8 +1199,8 @@ the field names:: >>> w.writeheader() "name","dept" >>> w.writerows([ - {'name': 'tom', 'dept': 'accounting'}, - {'name': 'susan', 'dept': 'Salesl'}]) + ... {'name': 'tom', 'dept': 'accounting'}, + ... {'name': 'susan', 'dept': 'Salesl'}]) "tom","accounting" "susan","sales" @@ -1423,14 +1425,14 @@ function can return *None*:: >>> import tarfile, glob >>> def myfilter(tarinfo): - if tarinfo.isfile(): # only save real files - tarinfo.uname = 'monty' # redact the user name - return tarinfo + ... if tarinfo.isfile(): # only save real files + ... tarinfo.uname = 'monty' # redact the user name + ... return tarinfo >>> with tarfile.open(name='myarchive.tar.gz', mode='w:gz') as tf: - for filename in glob.glob('*.txt'): - tf.add(filename, filter=myfilter) - tf.list() + ... for filename in glob.glob('*.txt'): + ... tf.add(filename, filter=myfilter) + ... tf.list() -rw-r--r-- monty/501 902 2011-01-26 17:59:11 annotations.txt -rw-r--r-- monty/501 123 2011-01-26 17:59:11 general_questions.txt -rw-r--r-- monty/501 3514 2011-01-26 17:59:11 prion.txt @@ -1536,26 +1538,26 @@ step is non-destructive (the original files are left unchanged). >>> import shutil, pprint - >>> os.chdir('mydata') # change to the source directory + >>> os.chdir('mydata') # change to the source directory >>> f = shutil.make_archive('/var/backup/mydata', - 'zip') # archive the current directory - >>> f # show the name of archive + ... 'zip') # archive the current directory + >>> f # show the name of archive '/var/backup/mydata.zip' - >>> os.chdir('tmp') # change to an unpacking + >>> os.chdir('tmp') # change to an unpacking >>> shutil.unpack_archive('/var/backup/mydata.zip') # recover the data - >>> pprint.pprint(shutil.get_archive_formats()) # display known formats + >>> pprint.pprint(shutil.get_archive_formats()) # display known formats [('bztar', "bzip2'ed tar-file"), ('gztar', "gzip'ed tar-file"), ('tar', 'uncompressed tar file'), ('zip', 'ZIP file')] - >>> shutil.register_archive_format( # register a new archive format - name = 'xz', - function = xz.compress, # callable archiving function - extra_args = [('level', 8)], # arguments to the function - description = 'xz compression' - ) + >>> shutil.register_archive_format( # register a new archive format + ... name='xz', + ... function=xz.compress, # callable archiving function + ... extra_args=[('level', 8)], # arguments to the function + ... description='xz compression' + ... ) (Contributed by Tarek Ziadé.) @@ -1854,7 +1856,7 @@ inspect >>> from inspect import getgeneratorstate >>> def gen(): - yield 'demo' + ... yield 'demo' >>> g = gen() >>> getgeneratorstate(g) 'GEN_CREATED' @@ -1874,11 +1876,11 @@ inspect change state while it is searching:: >>> class A: - @property - def f(self): - print('Running') - return 10 - + ... @property + ... def f(self): + ... print('Running') + ... return 10 + ... >>> a = A() >>> getattr(a, 'f') Running @@ -2102,19 +2104,19 @@ Config parsers gained a new API based on the mapping protocol:: >>> parser = ConfigParser() >>> parser.read_string(""" - [DEFAULT] - location = upper left - visible = yes - editable = no - color = blue - - [main] - title = Main Menu - color = green - - [options] - title = Options - """) + ... [DEFAULT] + ... location = upper left + ... visible = yes + ... editable = no + ... color = blue + ... + ... [main] + ... title = Main Menu + ... color = green + ... + ... [options] + ... title = Options + ... """) >>> parser['main']['color'] 'green' >>> parser['main']['editable'] @@ -2138,24 +2140,24 @@ handler :class:`~configparser.ExtendedInterpolation`:: >>> parser = ConfigParser(interpolation=ExtendedInterpolation()) >>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'}, - 'custom': {'prefix': '/usr/local'}}) + ... 'custom': {'prefix': '/usr/local'}}) >>> parser.read_string(""" - [buildout] - parts = - zope9 - instance - find-links = - ${buildout:directory}/downloads/dist - - [zope9] - recipe = plone.recipe.zope9install - location = /opt/zope - - [instance] - recipe = plone.recipe.zope9instance - zope9-location = ${zope9:location} - zope-conf = ${custom:prefix}/etc/zope.conf - """) + ... [buildout] + ... parts = + ... zope9 + ... instance + ... find-links = + ... ${buildout:directory}/downloads/dist + ... + ... [zope9] + ... recipe = plone.recipe.zope9install + ... location = /opt/zope + ... + ... [instance] + ... recipe = plone.recipe.zope9instance + ... zope9-location = ${zope9:location} + ... zope-conf = ${custom:prefix}/etc/zope.conf + ... """) >>> parser['buildout']['find-links'] '\n/home/ambv/zope9/downloads/dist' >>> parser['instance']['zope-conf'] @@ -2207,9 +2209,9 @@ string, then the *safe*, *encoding*, and *error* parameters are sent to :func:`~urllib.parse.quote_plus` for encoding:: >>> urllib.parse.urlencode([ - ('type', 'telenovela'), - ('name', '¿Dónde Está Elisa?')], - encoding='latin-1') + ... ('type', 'telenovela'), + ... ('name', '¿Dónde Está Elisa?')], + ... encoding='latin-1') 'type=telenovela&name=%BFD%F3nde+Est%E1+Elisa%3F' As detailed in :ref:`parsing-ascii-encoded-bytes`, all the :mod:`urllib.parse` diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst index 779f7f4..2096b0b 100644 --- a/Doc/whatsnew/3.3.rst +++ b/Doc/whatsnew/3.3.rst @@ -440,15 +440,15 @@ return a final value to the outer generator:: ... >>> tallies = [] >>> acc = gather_tallies(tallies) - >>> next(acc) # Ensure the accumulator is ready to accept values + >>> next(acc) # Ensure the accumulator is ready to accept values >>> for i in range(4): ... acc.send(i) ... - >>> acc.send(None) # Finish the first tally + >>> acc.send(None) # Finish the first tally >>> for i in range(5): ... acc.send(i) ... - >>> acc.send(None) # Finish the second tally + >>> acc.send(None) # Finish the second tally >>> tallies [6, 10] diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst index 339b586..6edc1b1 100644 --- a/Doc/whatsnew/3.4.rst +++ b/Doc/whatsnew/3.4.rst @@ -746,7 +746,7 @@ optional *current_offset*), and the resulting object can be iterated to produce method, equivalent to calling :mod:`~dis.dis` on the constructor argument, but returned as a multi-line string:: - >>> bytecode = dis.Bytecode(lambda x: x +1, current_offset=3) + >>> bytecode = dis.Bytecode(lambda x: x + 1, current_offset=3) >>> for instr in bytecode: ... print('{} ({})'.format(instr.opname, instr.opcode)) LOAD_FAST (124) |